aws-cdk-lib.aws_cognito.CfnUserPool.PasswordPolicyProperty

interface PasswordPolicyProperty

LanguageType name
.NETAmazon.CDK.AWS.Cognito.CfnUserPool.PasswordPolicyProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool_PasswordPolicyProperty
Javasoftware.amazon.awscdk.services.cognito.CfnUserPool.PasswordPolicyProperty
Pythonaws_cdk.aws_cognito.CfnUserPool.PasswordPolicyProperty
TypeScript aws-cdk-lib » aws_cognito » CfnUserPool » PasswordPolicyProperty

The password policy type.

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,
  requireLowercase: false,
  requireNumbers: false,
  requireSymbols: false,
  requireUppercase: false,
  temporaryPasswordValidityDays: 123,
};

Properties

NameTypeDescription
minimumLength?numberThe minimum length of the password in the policy that you have set.
requireLowercase?boolean | IResolvableIn the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
requireNumbers?boolean | IResolvableIn the password policy that you have set, refers to whether you have required users to use at least one number in their password.
requireSymbols?boolean | IResolvableIn the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
requireUppercase?boolean | IResolvableIn the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
temporaryPasswordValidityDays?numberThe 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.


requireLowercase?

Type: boolean | IResolvable (optional)

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.


requireNumbers?

Type: boolean | IResolvable (optional)

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


requireSymbols?

Type: boolean | IResolvable (optional)

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


requireUppercase?

Type: boolean | IResolvable (optional)

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.


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.

When you set TemporaryPasswordValidityDays for a user pool, you can no longer set a value for the legacy UnusedAccountValidityDays parameter in that user pool.