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

Class UserType

java.lang.Object
software.amazon.awssdk.services.cognitoidentityprovider.model.UserType
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UserType.Builder,UserType>
@Generated("software.amazon.awssdk:codegen") public final class UserType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UserType.Builder,UserType>

A user profile in a Amazon Cognito user pool.

See Also:

  • Method Details

    • username

      public final String username()

      The user name of the user you want to describe.

      Returns:
      The user name of the user you want to describe.

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • attributes

      public final List<AttributeType> attributes()

      A container with information about the user type attributes.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

      Returns:
      A container with information about the user type attributes.

    • userCreateDate

      public final Instant userCreateDate()

      The creation date of the user.

      Returns:
      The creation date of the user.

    • userLastModifiedDate

      public final 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.

      Returns:
      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.

    • enabled

      public final Boolean enabled()

      Specifies whether the user is enabled.

      Returns:
      Specifies whether the user is enabled.

    • userStatus

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, userStatus will return UserStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userStatusAsString().

      Returns:
      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.

      See Also:

    • userStatusAsString

      public final String userStatusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, userStatus will return UserStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userStatusAsString().

      Returns:
      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.

      See Also:

    • hasMfaOptions

      public final boolean hasMfaOptions()
      For responses, this returns true if the service returned a value for the MFAOptions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • mfaOptions

      public final List<MFAOptionType> mfaOptions()

      The MFA options for the user.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMfaOptions() method.

      Returns:
      The MFA options for the user.

    • toBuilder

      public UserType.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UserType.Builder,UserType>
      Returns:
      a builder for type T

    • builder

      public static UserType.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UserType.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.