AWS::Cognito::UserPool PasswordPolicy
The password policy type.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "MinimumLength" :
Integer
, "PasswordHistorySize" :Integer
, "RequireLowercase" :Boolean
, "RequireNumbers" :Boolean
, "RequireSymbols" :Boolean
, "RequireUppercase" :Boolean
, "TemporaryPasswordValidityDays" :Integer
}
YAML
MinimumLength:
Integer
PasswordHistorySize:Integer
RequireLowercase:Boolean
RequireNumbers:Boolean
RequireSymbols:Boolean
RequireUppercase:Boolean
TemporaryPasswordValidityDays:Integer
Properties
MinimumLength
-
The minimum length of the password in the policy that you have set. This value can't be less than 6.
Required: No
Type: Integer
Minimum:
6
Maximum:
99
Update requires: No interruption
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, wheren
is the value ofPasswordHistorySize
.Password history isn't enforced and isn't displayed in DescribeUserPool responses when you set this value to
0
or don't provide it. To activate this setting, advanced security features must be active in your user pool.Required: No
Type: Integer
Minimum:
0
Maximum:
24
Update requires: No interruption
RequireLowercase
-
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.
Required: No
Type: Boolean
Update requires: No interruption
RequireNumbers
-
In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
Required: No
Type: Boolean
Update requires: No interruption
RequireSymbols
-
In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
Required: No
Type: Boolean
Update requires: No interruption
RequireUppercase
-
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.
Required: No
Type: Boolean
Update requires: No interruption
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 of0
, Amazon Cognito treats it as a null value and setsTemporaryPasswordValidityDays
to its default value.Note
When you set
TemporaryPasswordValidityDays
for a user pool, you can no longer set a value for the legacyUnusedAccountValidityDays
parameter in that user pool.Required: No
Type: Integer
Minimum:
0
Maximum:
365
Update requires: No interruption