Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface UserType.Builder

All Superinterfaces:
Buildable, CopyableBuilder<UserType.Builder,UserType>, SdkBuilder<UserType.Builder,UserType>, SdkPojo
Enclosing class:
UserType
@Mutable @NotThreadSafe public static interface UserType.Builder extends SdkPojo, CopyableBuilder<UserType.Builder,UserType>

  • Method Details

    • 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 example email.
      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 example email.
      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 email.

      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<AttributeType>).

      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:

    • 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 Date object.

      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 Java Date object.
      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 Date object.

      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 Java Date object.
      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.

      • 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.

      The statuses ARCHIVED, UNKNOWN, and COMPROMISED are no longer used.

      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.

      • 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.

      The statuses ARCHIVED, UNKNOWN, and COMPROMISED are no longer used.

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

    • 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.

      • 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.

      The statuses ARCHIVED, UNKNOWN, and COMPROMISED are no longer used.

      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.

      • 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.

      The statuses ARCHIVED, UNKNOWN, and COMPROMISED are no longer used.

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

    • 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 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<MFAOptionType>).

      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: