Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.PoliciesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.PoliciesProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

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

A list of user pool policies.

Contains the policy that sets password-complexity requirements.

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.*;
 PoliciesProperty policiesProperty = PoliciesProperty.builder()
         .passwordPolicy(PasswordPolicyProperty.builder()
                 .minimumLength(123)
                 .passwordHistorySize(123)
                 .requireLowercase(false)
                 .requireNumbers(false)
                 .requireSymbols(false)
                 .requireUppercase(false)
                 .temporaryPasswordValidityDays(123)
                 .build())
         .signInPolicy(SignInPolicyProperty.builder()
                 .allowedFirstAuthFactors(List.of("allowedFirstAuthFactors"))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.PoliciesProperty.Builder	builder()
default Object	getPasswordPolicy()	The password policy settings for a user pool, including complexity, history, and length requirements.
default Object	getSignInPolicy()	The policy for allowed types of authentication in a user pool.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPasswordPolicy

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

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

Returns union: either IResolvable or CfnUserPool.PasswordPolicyProperty

See Also:

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

getSignInPolicy

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

The policy for allowed types of authentication in a user pool.

To activate this setting, your user pool must be in the Essentials tier or higher.

Returns union: either IResolvable or CfnUserPool.SignInPolicyProperty

See Also:

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

builder

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

Returns:

a CfnUserPool.PoliciesProperty.Builder of CfnUserPool.PoliciesProperty