interface PasswordPolicyProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Cognito.CfnUserPool.PasswordPolicyProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool_PasswordPolicyProperty |
![]() | software.amazon.awscdk.services.cognito.CfnUserPool.PasswordPolicyProperty |
![]() | aws_cdk.aws_cognito.CfnUserPool.PasswordPolicyProperty |
![]() | aws-cdk-lib » aws_cognito » CfnUserPool » PasswordPolicyProperty |
The password policy settings for a user pool, including complexity, history, and length requirements.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const passwordPolicyProperty: cognito.CfnUserPool.PasswordPolicyProperty = {
minimumLength: 123,
passwordHistorySize: 123,
requireLowercase: false,
requireNumbers: false,
requireSymbols: false,
requireUppercase: false,
temporaryPasswordValidityDays: 123,
};
Properties
Name | Type | Description |
---|---|---|
minimum | number | The minimum length of the password in the policy that you have set. |
password | number | The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. |
require | boolean | IResolvable | The requirement in a password policy that users must include at least one lowercase letter in their password. |
require | boolean | IResolvable | The requirement in a password policy that users must include at least one number in their password. |
require | boolean | IResolvable | The requirement in a password policy that users must include at least one symbol in their password. |
require | boolean | IResolvable | The requirement in a password policy that users must include at least one uppercase letter in their password. |
temporary | number | The number of days a temporary password is valid in the password policy. |
minimumLength?
Type:
number
(optional)
The minimum length of the password in the policy that you have set.
This value can't be less than 6.
passwordHistorySize?
Type:
number
(optional)
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
.
requireLowercase?
Type:
boolean |
IResolvable
(optional)
The requirement in a password policy that users must include at least one lowercase letter in their password.
requireNumbers?
Type:
boolean |
IResolvable
(optional)
The requirement in a password policy that users must include at least one number in their password.
requireSymbols?
Type:
boolean |
IResolvable
(optional)
The requirement in a password policy that users must include at least one symbol in their password.
requireUppercase?
Type:
boolean |
IResolvable
(optional)
The requirement in a password policy that users must include at least one uppercase letter in their password.
temporaryPasswordValidityDays?
Type:
number
(optional)
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 legacyUnusedAccountValidityDays
parameter in that user pool.