aws-cdk-lib.aws_cognito.AutoVerifiedAttrs

interface AutoVerifiedAttrs

LanguageType name
.NETAmazon.CDK.AWS.Cognito.AutoVerifiedAttrs
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#AutoVerifiedAttrs
Javasoftware.amazon.awscdk.services.cognito.AutoVerifiedAttrs
Pythonaws_cdk.aws_cognito.AutoVerifiedAttrs
TypeScript (source)aws-cdk-lib » aws_cognito » AutoVerifiedAttrs

Attributes that can be automatically verified for users in a user pool.

Example

new cognito.UserPool(this, 'myuserpool', {
  // ...
  // ...
  signInAliases: { username: true, email: true },
  autoVerify: { email: true, phone: true },
});

Properties

NameTypeDescription
email?booleanWhether the email address of the user should be auto verified at sign up.
phone?booleanWhether the phone number of the user should be auto verified at sign up.

email?

Type: boolean (optional, default: true, if email is turned on for signIn. false, otherwise.)

Whether the email address of the user should be auto verified at sign up.

Note: If both email and phone is set, Cognito only verifies the phone number. To also verify email, see here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html


phone?

Type: boolean (optional, default: true, if phone is turned on for signIn. false, otherwise.)

Whether the phone number of the user should be auto verified at sign up.