You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::PasswordPolicyType

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PasswordPolicyType as input to an Aws::Client method, you can use a vanilla Hash:

{
  minimum_length: 1,
  require_uppercase: false,
  require_lowercase: false,
  require_numbers: false,
  require_symbols: false,
  temporary_password_validity_days: 1,
}

The password policy type.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#minimum_lengthInteger

The minimum length of the password policy that you have set. Cannot be less than 6.

Returns:

  • (Integer)

    The minimum length of the password policy that you have set.

#require_lowercaseBoolean

In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.

Returns:

  • (Boolean)

    In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.

#require_numbersBoolean

In the password policy that you have set, refers to whether you have required users to use at least one number in their password.

Returns:

  • (Boolean)

    In the password policy that you have set, refers to whether you have required users to use at least one number in their password.

#require_symbolsBoolean

In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.

Returns:

  • (Boolean)

    In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.

#require_uppercaseBoolean

In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.

Returns:

  • (Boolean)

    In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.

#temporary_password_validity_daysInteger

In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.

When you set TemporaryPasswordValidityDays for a user pool, you will no longer be able to set the deprecated UnusedAccountValidityDays value for that user pool.

Returns:

  • (Integer)

    In the password policy you have set, refers to the number of days a temporary password is valid.