Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.PasswordPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.PasswordPolicyProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(Stable)
public static interface CfnUserPool.PasswordPolicyProperty
extends software.amazon.jsii.JsiiSerializable

The password policy settings for a user pool, including complexity, history, and length requirements.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 PasswordPolicyProperty passwordPolicyProperty = PasswordPolicyProperty.builder()
         .minimumLength(123)
         .passwordHistorySize(123)
         .requireLowercase(false)
         .requireNumbers(false)
         .requireSymbols(false)
         .requireUppercase(false)
         .temporaryPasswordValidityDays(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPool.PasswordPolicyProperty.Builder	A builder for CfnUserPool.PasswordPolicyProperty
static final class	CfnUserPool.PasswordPolicyProperty.Jsii$Proxy	An implementation for CfnUserPool.PasswordPolicyProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.PasswordPolicyProperty.Builder	builder()
default Number	getMinimumLength()	The minimum length of the password in the policy that you have set.
default Number	getPasswordHistorySize()	The number of previous passwords that you want Amazon Cognito to restrict each user from reusing.
default Object	getRequireLowercase()	The requirement in a password policy that users must include at least one lowercase letter in their password.
default Object	getRequireNumbers()	The requirement in a password policy that users must include at least one number in their password.
default Object	getRequireSymbols()	The requirement in a password policy that users must include at least one symbol in their password.
default Object	getRequireUppercase()	The requirement in a password policy that users must include at least one uppercase letter in their password.
default Number	getTemporaryPasswordValidityDays()	The number of days a temporary password is valid in the password policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMinimumLength

@Stability(Stable)
@Nullable
default Number getMinimumLength()

The minimum length of the password in the policy that you have set.

This value can't be less than 6.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-minimumlength

getPasswordHistorySize

@Stability(Stable)
@Nullable
default Number getPasswordHistorySize()

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 .

Password history isn't enforced and isn't displayed in DescribeUserPool responses when you set this value to 0 or don't provide it. To activate this setting, advanced security features must be active in your user pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-passwordhistorysize

getRequireLowercase

@Stability(Stable)
@Nullable
default Object getRequireLowercase()

The requirement in a password policy that users must include at least one lowercase letter in their password.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirelowercase

getRequireNumbers

@Stability(Stable)
@Nullable
default Object getRequireNumbers()

The requirement in a password policy that users must include at least one number in their password.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requirenumbers

getRequireSymbols

@Stability(Stable)
@Nullable
default Object getRequireSymbols()

The requirement in a password policy that users must include at least one symbol in their password.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requiresymbols

getRequireUppercase

@Stability(Stable)
@Nullable
default Object getRequireUppercase()

The requirement in a password policy that users must include at least one uppercase letter in their password.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-requireuppercase

getTemporaryPasswordValidityDays

@Stability(Stable)
@Nullable
default Number getTemporaryPasswordValidityDays()

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 legacy UnusedAccountValidityDays parameter in that user pool.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-passwordpolicy.html#cfn-cognito-userpool-passwordpolicy-temporarypasswordvaliditydays

builder

@Stability(Stable)
static CfnUserPool.PasswordPolicyProperty.Builder builder()

Returns:

a CfnUserPool.PasswordPolicyProperty.Builder of CfnUserPool.PasswordPolicyProperty