interface SignInPolicyProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.Cognito.Mixins.CfnUserPoolPropsMixin.SignInPolicyProperty |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscognito/mixins#CfnUserPoolPropsMixin_SignInPolicyProperty |
 Java | software.amazon.awscdk.mixins.preview.services.cognito.mixins.CfnUserPoolPropsMixin.SignInPolicyProperty |
 Python | aws_cdk.mixins_preview.aws_cognito.mixins.CfnUserPoolPropsMixin.SignInPolicyProperty |
 TypeScript | @aws-cdk/mixins-preview » aws_cognito » mixins » CfnUserPoolPropsMixin » SignInPolicyProperty |
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 { mixins as cognito_mixins } from '@aws-cdk/mixins-preview/aws-cognito';
const signInPolicyProperty: cognito_mixins.CfnUserPoolPropsMixin.SignInPolicyProperty = {
allowedFirstAuthFactors: ['allowedFirstAuthFactors'],
};
Properties
| Name | Type | Description |
|---|---|---|
| allowed | string[] | The sign-in methods that a user pool supports as the first factor. |
allowedFirstAuthFactors?
Type:
string[]
(optional)
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 ,