software.amazon.awssdk.services.cognitoidentityprovider.model

Interface UserType.Builder

All Superinterfaces:

Buildable, CopyableBuilder<UserType.Builder,UserType>, SdkBuilder<UserType.Builder,UserType>, SdkPojo

Enclosing class:

UserType

public static interface UserType.Builder
extends SdkPojo, CopyableBuilder<UserType.Builder,UserType>

Method Summary

Modifier and Type	Method and Description
UserType.Builder	attributes(AttributeType... attributes) A container with information about the user type attributes.
UserType.Builder	attributes(Collection<AttributeType> attributes) A container with information about the user type attributes.
UserType.Builder	attributes(Consumer<AttributeType.Builder>... attributes) A container with information about the user type attributes.
UserType.Builder	enabled(Boolean enabled) Specifies whether the user is enabled.
UserType.Builder	mfaOptions(Collection<MFAOptionType> mfaOptions) The MFA options for the user.
UserType.Builder	mfaOptions(Consumer<MFAOptionType.Builder>... mfaOptions) The MFA options for the user.
UserType.Builder	mfaOptions(MFAOptionType... mfaOptions) The MFA options for the user.
UserType.Builder	userCreateDate(Instant userCreateDate) The creation date of the user.
UserType.Builder	userLastModifiedDate(Instant userLastModifiedDate) The last modified date of the user.
UserType.Builder	username(String username) The user name of the user you want to describe.
UserType.Builder	userStatus(String userStatus) The user status.
UserType.Builder	userStatus(UserStatusType userStatus) The user status.

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

equalsBySdkFields, 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

UserType.Builder username(String username)

The user name of the user you want to describe.

Parameters:

username - The user name of the user you want to describe.

Returns:

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

attributes

UserType.Builder attributes(Collection<AttributeType> attributes)

A container with information about the user type attributes.

Parameters:

attributes - A container with information about the user type attributes.

Returns:

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

attributes

UserType.Builder attributes(AttributeType... attributes)

A container with information about the user type attributes.

Parameters:

attributes - A container with information about the user type attributes.

Returns:

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

attributes

UserType.Builder attributes(Consumer<AttributeType.Builder>... attributes)

A container with information about the user type attributes.

This is a convenience method that creates an instance of the AttributeType.Builder avoiding the need to create one manually via AttributeType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #attributes(List).

Parameters:

attributes - a consumer that will call methods on AttributeType.Builder

Returns:

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

See Also:

#attributes(java.util.Collection)

userCreateDate

UserType.Builder userCreateDate(Instant userCreateDate)

The creation date of the user.

Parameters:

userCreateDate - The creation date of the user.

Returns:

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

userLastModifiedDate

UserType.Builder userLastModifiedDate(Instant userLastModifiedDate)

The last modified date of the user.

Parameters:

userLastModifiedDate - The last modified date of the user.

Returns:

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

enabled

UserType.Builder enabled(Boolean enabled)

Specifies whether the user is enabled.

Parameters:

enabled - Specifies whether the user is enabled.

Returns:

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

userStatus

UserType.Builder userStatus(String userStatus)

The user status. This can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• EXTERNAL_PROVIDER - User signed in with a third-party IdP.

• ARCHIVED - User is no longer active.

• UNKNOWN - User status isn't known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.

Parameters:

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

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• EXTERNAL_PROVIDER - User signed in with a third-party IdP.

• ARCHIVED - User is no longer active.

• UNKNOWN - User status isn't known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their 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

UserType.Builder userStatus(UserStatusType userStatus)

The user status. This can be one of the following:

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• EXTERNAL_PROVIDER - User signed in with a third-party IdP.

• ARCHIVED - User is no longer active.

• UNKNOWN - User status isn't known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their password to a new value before doing anything else.

Parameters:

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

• UNCONFIRMED - User has been created but not confirmed.

• CONFIRMED - User has been confirmed.

• EXTERNAL_PROVIDER - User signed in with a third-party IdP.

• ARCHIVED - User is no longer active.

• UNKNOWN - User status isn't known.

• RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they 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 their 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

UserType.Builder mfaOptions(Collection<MFAOptionType> mfaOptions)

The MFA options for the user.

Parameters:

mfaOptions - The MFA options for the user.

Returns:

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

mfaOptions

UserType.Builder mfaOptions(MFAOptionType... mfaOptions)

The MFA options for the user.

Parameters:

mfaOptions - The MFA options for the user.

Returns:

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

mfaOptions

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

The MFA options for the user.

This is a convenience method that creates an instance of the MFAOptionType.Builder avoiding the need to create one manually via MFAOptionType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #mfaOptions(List).

Parameters:

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

Returns:

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

See Also:

#mfaOptions(java.util.Collection)