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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description UserType.Builderattributes(Collection<AttributeType> attributes)Names and values of a user's attributes, for exampleemail.UserType.Builderattributes(Consumer<AttributeType.Builder>... attributes)Names and values of a user's attributes, for exampleemail.UserType.Builderattributes(AttributeType... attributes)Names and values of a user's attributes, for exampleemail.UserType.Builderenabled(Boolean enabled)Indicates whether the user's account is enabled or disabled.UserType.BuildermfaOptions(Collection<MFAOptionType> mfaOptions)The user's MFA configuration.UserType.BuildermfaOptions(Consumer<MFAOptionType.Builder>... mfaOptions)The user's MFA configuration.UserType.BuildermfaOptions(MFAOptionType... mfaOptions)The user's MFA configuration.UserType.BuilderuserCreateDate(Instant userCreateDate)The date and time when the item was created.UserType.BuilderuserLastModifiedDate(Instant userLastModifiedDate)The date and time when the item was modified.UserType.Builderusername(String username)The user's username.UserType.BuilderuserStatus(String userStatus)The user status.UserType.BuilderuserStatus(UserStatusType userStatus)The user status.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
username
UserType.Builder username(String username)
The user's username.
- Parameters:
username- The user's username.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributes
UserType.Builder attributes(Collection<AttributeType> attributes)
Names and values of a user's attributes, for example
email.- Parameters:
attributes- Names and values of a user's attributes, for exampleemail.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributes
UserType.Builder attributes(AttributeType... attributes)
Names and values of a user's attributes, for example
email.- Parameters:
attributes- Names and values of a user's attributes, for exampleemail.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
attributes
UserType.Builder attributes(Consumer<AttributeType.Builder>... attributes)
Names and values of a user's attributes, for example
This is a convenience method that creates an instance of theemail.AttributeType.Builderavoiding the need to create one manually viaAttributeType.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#attributes(List.) - Parameters:
attributes- a consumer that will call methods onAttributeType.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 date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Dateobject.- Parameters:
userCreateDate- The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a JavaDateobject.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userLastModifiedDate
UserType.Builder userLastModifiedDate(Instant userLastModifiedDate)
The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java
Dateobject.- Parameters:
userLastModifiedDate- The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a JavaDateobject.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enabled
UserType.Builder enabled(Boolean enabled)
Indicates whether the user's account is enabled or disabled.
- Parameters:
enabled- Indicates whether the user's account is enabled or disabled.- 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.
-
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.
-
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.
-
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.
-
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 user's MFA configuration.
- Parameters:
mfaOptions- The user's MFA configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mfaOptions
UserType.Builder mfaOptions(MFAOptionType... mfaOptions)
The user's MFA configuration.
- Parameters:
mfaOptions- The user's MFA configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mfaOptions
UserType.Builder mfaOptions(Consumer<MFAOptionType.Builder>... mfaOptions)
The user's MFA configuration.
This is a convenience method that creates an instance of theMFAOptionType.Builderavoiding the need to create one manually viaMFAOptionType.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#mfaOptions(List.) - Parameters:
mfaOptions- a consumer that will call methods onMFAOptionType.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#mfaOptions(java.util.Collection)
-
-