PasswordPolicy Struct
Password policy for User Pools.
Example
ts
new cognito.UserPool(this, 'myuserpool', {
// ...
passwordPolicy: {
minLength: 12,
requireLowercase: true,
requireUppercase: true,
requireDigits: true,
requireSymbols: true,
tempPasswordValidity: Duration.days(3),
},
});
Properties
minLengthoptionalnumbermin_lengthoptionalint | floatminLengthoptionalNumberMinLengthoptionaldoubleMinLengthoptional*float64= 8#Minimum length required for a user's password.
passwordHistorySizeoptionalnumberpassword_history_sizeoptionalint | floatpasswordHistorySizeoptionalNumberPasswordHistorySizeoptionaldoublePasswordHistorySizeoptional*float64#The number of previous passwords that you want Amazon Cognito to restrict each user from reusing.
Default: undefined - Cognito default setting is no restriction
passwordHistorySize cannot be set when featurePlan is FeaturePlan.LITE.
requireDigitsoptionalbooleanrequire_digitsoptionalboolrequireDigitsoptionalBooleanRequireDigitsoptionalboolRequireDigitsoptional*bool= true#Whether the user is required to have digits in their password.
requireLowercaseoptionalbooleanrequire_lowercaseoptionalboolrequireLowercaseoptionalBooleanRequireLowercaseoptionalboolRequireLowercaseoptional*bool= true#Whether the user is required to have lowercase characters in their password.
requireSymbolsoptionalbooleanrequire_symbolsoptionalboolrequireSymbolsoptionalBooleanRequireSymbolsoptionalboolRequireSymbolsoptional*bool= true#Whether the user is required to have symbols in their password.
requireUppercaseoptionalbooleanrequire_uppercaseoptionalboolrequireUppercaseoptionalBooleanRequireUppercaseoptionalboolRequireUppercaseoptional*bool= true#Whether the user is required to have uppercase characters in their password.
tempPasswordValidityoptionalDurationtemp_password_validityoptionalDurationtempPasswordValidityoptionalDurationTempPasswordValidityoptionalDurationTempPasswordValidityoptionalDuration= Duration.days(7)#The length of time the temporary password generated by an admin is valid.
This must be provided as whole days, like Duration.days(3) or Duration.hours(48). Fractional days, such as Duration.hours(20), will generate an error.