Interface CfnUserPoolPropsMixin.IPasswordPolicyProperty
The password policy settings for a user pool, including complexity, history, and length requirements.
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Cognito
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public interface CfnUserPoolPropsMixin.IPasswordPolicyPropertySyntax (vb)
Public Interface CfnUserPoolPropsMixin.IPasswordPolicyPropertyRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.CfnPropertyMixins.AWS.Cognito;
var passwordPolicyProperty = new PasswordPolicyProperty {
MinimumLength = 123,
PasswordHistorySize = 123,
RequireLowercase = false,
RequireNumbers = false,
RequireSymbols = false,
RequireUppercase = false,
TemporaryPasswordValidityDays = 123
};Synopsis
Properties
| MinimumLength | The minimum length of the password in the policy that you have set. |
| PasswordHistorySize | The number of previous passwords that you want Amazon Cognito to restrict each user from reusing. |
| RequireLowercase | The requirement in a password policy that users must include at least one lowercase letter in their password. |
| RequireNumbers | The requirement in a password policy that users must include at least one number in their password. |
| RequireSymbols | The requirement in a password policy that users must include at least one symbol in their password. |
| RequireUppercase | The requirement in a password policy that users must include at least one uppercase letter in their password. |
| TemporaryPasswordValidityDays | The number of days a temporary password is valid in the password policy. |
Properties
MinimumLength
The minimum length of the password in the policy that you have set.
double? MinimumLength { get; }Property Value
Remarks
PasswordHistorySize
The number of previous passwords that you want Amazon Cognito to restrict each user from reusing.
double? PasswordHistorySize { get; }Property Value
Remarks
Users can't set a password that matches any of n previous passwords, where n is the value of PasswordHistorySize .
RequireLowercase
The requirement in a password policy that users must include at least one lowercase letter in their password.
object? RequireLowercase { get; }Property Value
Remarks
RequireNumbers
The requirement in a password policy that users must include at least one number in their password.
object? RequireNumbers { get; }Property Value
Remarks
RequireSymbols
The requirement in a password policy that users must include at least one symbol in their password.
object? RequireSymbols { get; }Property Value
Remarks
RequireUppercase
The requirement in a password policy that users must include at least one uppercase letter in their password.
object? RequireUppercase { get; }Property Value
Remarks
TemporaryPasswordValidityDays
The number of days a temporary password is valid in the password policy.
double? TemporaryPasswordValidityDays { get; }Property Value
Remarks
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 <code>TemporaryPasswordValidityDays</code> for a user pool, you can no longer set a value for the legacy <code>UnusedAccountValidityDays</code> parameter in that user pool.