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

Class PasswordPolicyType

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

The password policy settings for a user pool, including complexity, history, and length requirements.

See Also:

  • Method Details

    • minimumLength

      public final Integer minimumLength()

      The minimum length of the password in the policy that you have set. This value can't be less than 6.

      Returns:
      The minimum length of the password in the policy that you have set. This value can't be less than 6.

    • requireUppercase

      public final Boolean requireUppercase()

      The requirement in a password policy that users must include at least one uppercase letter in their password.

      Returns:
      The requirement in a password policy that users must include at least one uppercase letter in their password.

    • requireLowercase

      public final Boolean requireLowercase()

      The requirement in a password policy that users must include at least one lowercase letter in their password.

      Returns:
      The requirement in a password policy that users must include at least one lowercase letter in their password.

    • requireNumbers

      public final Boolean requireNumbers()

      The requirement in a password policy that users must include at least one number in their password.

      Returns:
      The requirement in a password policy that users must include at least one number in their password.

    • requireSymbols

      public final Boolean requireSymbols()

      The requirement in a password policy that users must include at least one symbol in their password.

      Returns:
      The requirement in a password policy that users must include at least one symbol in their password.

    • passwordHistorySize

      public final Integer passwordHistorySize()

      The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of n previous passwords, where n is the value of PasswordHistorySize.

      Returns:
      The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. Users can't set a password that matches any of n previous passwords, where n is the value of PasswordHistorySize.

    • temporaryPasswordValidityDays

      public final Integer temporaryPasswordValidityDays()

      The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. Defaults to 7. If you submit a value of 0, Amazon Cognito treats it as a null value and sets TemporaryPasswordValidityDays to its default value.

      When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

      Returns:
      The number of days a temporary password is valid in the password policy. If the user doesn't sign in during this time, an administrator must reset their password. Defaults to 7. If you submit a value of 0, Amazon Cognito treats it as a null value and sets TemporaryPasswordValidityDays to its default value.

      When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.

    • toBuilder

      public PasswordPolicyType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<PasswordPolicyType.Builder,PasswordPolicyType>

    • builder

      public static PasswordPolicyType.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PasswordPolicyType.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo