Class AdminCreateUserConfigType

java.lang.Object
software.amazon.awssdk.services.cognitoidentityprovider.model.AdminCreateUserConfigType
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>

@Generated("software.amazon.awssdk:codegen") public final class AdminCreateUserConfigType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>

The configuration for creating a new user profile.

See Also:
  • Method Details

    • allowAdminCreateUserOnly

      public final Boolean allowAdminCreateUserOnly()

      Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

      Returns:
      Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
    • unusedAccountValidityDays

      public final Integer unusedAccountValidityDays()

      The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

      If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.

      Returns:
      The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

      If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.

    • inviteMessageTemplate

      public final MessageTemplateType inviteMessageTemplate()

      The message template to be used for the welcome message to new users.

      See also Customizing User Invitation Messages.

      Returns:
      The message template to be used for the welcome message to new users.

      See also Customizing User Invitation Messages.

    • 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<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>
      Returns:
      a builder for type T
    • builder

      public static AdminCreateUserConfigType.Builder builder()
    • serializableBuilderClass

      public static Class<? extends AdminCreateUserConfigType.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.