aws-cdk-lib.aws_cognito.CfnUserPool.SignInPolicyProperty

SignInPolicyProperty Struct

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.

Source

Generated code

Type last changed

v2.172.0 · 7 Dec 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const signInPolicyProperty: cognito.CfnUserPool.SignInPolicyProperty = {
  allowedFirstAuthFactors: ['allowedFirstAuthFactors'],
};

Properties

allowedFirstAuthFactors?optionalstring[]allowed_first_auth_factors?optionaltyping.List[str]allowedFirstAuthFactors?optionalList<String>AllowedFirstAuthFactors?optionalstring[]AllowedFirstAuthFactors?optional*[]*string#

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 ,