Interface UserType.Builder

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

        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.

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