PasswordPolicyProperty Struct
The password policy settings for a user pool, including complexity, history, and length requirements.
Example
ts
// 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
minimumLengthoptionalnumberminimum_lengthoptionalint | floatminimumLengthoptionalNumberMinimumLengthoptionaldoubleMinimumLengthoptional*float64#The minimum length of the password in the policy that you have set.
This value can't be less than 6.
passwordHistorySizeoptionalnumberpassword_history_sizeoptionalint | floatpasswordHistorySizeoptionalNumberPasswordHistorySizeoptionaldoublePasswordHistorySizeoptional*float64#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 .
requireLowercaseoptionalboolean | IResolvablerequire_lowercaseoptionaltyping.Union[bool, IResolvable]requireLowercaseoptionalBooleanRequireLowercaseoptionalboolRequireLowercaseoptionalinterface{}#The requirement in a password policy that users must include at least one lowercase letter in their password.
requireNumbersoptionalboolean | IResolvablerequire_numbersoptionaltyping.Union[bool, IResolvable]requireNumbersoptionalBooleanRequireNumbersoptionalboolRequireNumbersoptionalinterface{}#The requirement in a password policy that users must include at least one number in their password.
requireSymbolsoptionalboolean | IResolvablerequire_symbolsoptionaltyping.Union[bool, IResolvable]requireSymbolsoptionalBooleanRequireSymbolsoptionalboolRequireSymbolsoptionalinterface{}#The requirement in a password policy that users must include at least one symbol in their password.
requireUppercaseoptionalboolean | IResolvablerequire_uppercaseoptionaltyping.Union[bool, IResolvable]requireUppercaseoptionalBooleanRequireUppercaseoptionalboolRequireUppercaseoptionalinterface{}#The requirement in a password policy that users must include at least one uppercase letter in their password.
temporaryPasswordValidityDaysoptionalnumbertemporary_password_validity_daysoptionalint | floattemporaryPasswordValidityDaysoptionalNumberTemporaryPasswordValidityDaysoptionaldoubleTemporaryPasswordValidityDaysoptional*float64#The number of days a temporary password is valid in the password policy.
notes
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
TemporaryPasswordValidityDaysfor a user pool, you can no longer set a value for the legacyUnusedAccountValidityDaysparameter in that user pool.