software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AdminGetUserResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CognitoIdentityProviderResponse.Builder, CopyableBuilder<AdminGetUserResponse.Builder,AdminGetUserResponse>, SdkBuilder<AdminGetUserResponse.Builder,AdminGetUserResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

AdminGetUserResponse

public static interface AdminGetUserResponse.Builder
extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<AdminGetUserResponse.Builder,AdminGetUserResponse>

Method Summary

Modifier and Type	Method and Description
AdminGetUserResponse.Builder	enabled(Boolean enabled) Indicates that the status is enabled.
AdminGetUserResponse.Builder	mfaOptions(Collection<MFAOptionType> mfaOptions) Specifies the options for MFA (e.g., email or phone number).
AdminGetUserResponse.Builder	mfaOptions(Consumer<MFAOptionType.Builder>... mfaOptions) Specifies the options for MFA (e.g., email or phone number).
AdminGetUserResponse.Builder	mfaOptions(MFAOptionType... mfaOptions) Specifies the options for MFA (e.g., email or phone number).
AdminGetUserResponse.Builder	preferredMfaSetting(String preferredMfaSetting) The user's preferred MFA setting.
AdminGetUserResponse.Builder	userAttributes(AttributeType... userAttributes) An array of name-value pairs representing user attributes.
AdminGetUserResponse.Builder	userAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
AdminGetUserResponse.Builder	userAttributes(Consumer<AttributeType.Builder>... userAttributes) An array of name-value pairs representing user attributes.
AdminGetUserResponse.Builder	userCreateDate(Instant userCreateDate) The date the user was created.
AdminGetUserResponse.Builder	userLastModifiedDate(Instant userLastModifiedDate) The date the user was last modified.
AdminGetUserResponse.Builder	userMFASettingList(Collection<String> userMFASettingList) The list of the user's MFA settings.
AdminGetUserResponse.Builder	userMFASettingList(String... userMFASettingList) The list of the user's MFA settings.
AdminGetUserResponse.Builder	username(String username) The user name of the user about whom you are receiving information.
AdminGetUserResponse.Builder	userStatus(String userStatus) The user status.
AdminGetUserResponse.Builder	userStatus(UserStatusType userStatus) The user status.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

username

AdminGetUserResponse.Builder username(String username)

The user name of the user about whom you are receiving information.

Parameters:

username - The user name of the user about whom you are receiving information.

Returns:

Returns a reference to this object so that method calls can be chained together.

userAttributes

AdminGetUserResponse.Builder userAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

userAttributes

AdminGetUserResponse.Builder userAttributes(AttributeType... userAttributes)

An array of name-value pairs representing user attributes.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

userAttributes

AdminGetUserResponse.Builder userAttributes(Consumer<AttributeType.Builder>... userAttributes)

An array of name-value pairs representing user attributes.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #userAttributes(List).

Parameters:

userAttributes - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#userAttributes(List)

userCreateDate

AdminGetUserResponse.Builder userCreateDate(Instant userCreateDate)

The date the user was created.

Parameters:

userCreateDate - The date the user was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

userLastModifiedDate

AdminGetUserResponse.Builder userLastModifiedDate(Instant userLastModifiedDate)

The date the user was last modified.

Parameters:

userLastModifiedDate - The date the user was last modified.

Returns:

Returns a reference to this object so that method calls can be chained together.

enabled

AdminGetUserResponse.Builder enabled(Boolean enabled)

Indicates that the status is enabled.

Parameters:

enabled - Indicates that the status is enabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

userStatus

AdminGetUserResponse.Builder userStatus(String userStatus)

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

Parameters:

userStatus - The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserStatusType, UserStatusType

userStatus

AdminGetUserResponse.Builder userStatus(UserStatusType userStatus)

The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

Parameters:

userStatus - The user status. Can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• ARCHIVED - User is no longer active.

• COMPROMISED - User is disabled due to a potential security threat.

• UNKNOWN - User status is not known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

• FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserStatusType, UserStatusType

mfaOptions

AdminGetUserResponse.Builder mfaOptions(Collection<MFAOptionType> mfaOptions)

Specifies the options for MFA (e.g., email or phone number).

Parameters:

mfaOptions - Specifies the options for MFA (e.g., email or phone number).

Returns:

Returns a reference to this object so that method calls can be chained together.

mfaOptions

AdminGetUserResponse.Builder mfaOptions(MFAOptionType... mfaOptions)

Specifies the options for MFA (e.g., email or phone number).

Parameters:

mfaOptions - Specifies the options for MFA (e.g., email or phone number).

Returns:

Returns a reference to this object so that method calls can be chained together.

mfaOptions

AdminGetUserResponse.Builder mfaOptions(Consumer<MFAOptionType.Builder>... mfaOptions)

Specifies the options for MFA (e.g., email or phone number).

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #mfaOptions(List).

Parameters:

mfaOptions - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#mfaOptions(List)

preferredMfaSetting

AdminGetUserResponse.Builder preferredMfaSetting(String preferredMfaSetting)

The user's preferred MFA setting.

Parameters:

preferredMfaSetting - The user's preferred MFA setting.

Returns:

Returns a reference to this object so that method calls can be chained together.

userMFASettingList

AdminGetUserResponse.Builder userMFASettingList(Collection<String> userMFASettingList)

The list of the user's MFA settings.

Parameters:

userMFASettingList - The list of the user's MFA settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

userMFASettingList

AdminGetUserResponse.Builder userMFASettingList(String... userMFASettingList)

The list of the user's MFA settings.

Parameters:

userMFASettingList - The list of the user's MFA settings.

Returns:

Returns a reference to this object so that method calls can be chained together.