Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.SignInPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.SignInPolicyProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

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

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.

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.*;
 SignInPolicyProperty signInPolicyProperty = SignInPolicyProperty.builder()
         .allowedFirstAuthFactors(List.of("allowedFirstAuthFactors"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.SignInPolicyProperty.Builder	builder()
default List<String>	getAllowedFirstAuthFactors()	The sign-in methods that a user pool supports as the first factor.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowedFirstAuthFactors

@Stability(Stable)
@Nullable
default List<String> getAllowedFirstAuthFactors()

The sign-in methods that a user pool supports as the first factor.

You can permit users to start authentication with a standard username and password, or with other one-time password and hardware factors.

Supports values of EMAIL_OTP , SMS_OTP , WEB_AUTHN and PASSWORD ,

See Also:

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

builder

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

Returns:

a CfnUserPool.SignInPolicyProperty.Builder of CfnUserPool.SignInPolicyProperty