Interface IAutoVerifiedAttrs

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

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

public interface IAutoVerifiedAttrs

Examples

new UserPool(this, "myuserpool", new UserPoolProps {
                // ...
                // ...
                SignInAliases = new SignInAliases { Username = true, Email = true },
                AutoVerify = new AutoVerifiedAttrs { Email = true, Phone = true }
            });

Remarks

ExampleMetadata: infused

Properties

Email

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

bool? Email { get; }

Property Value

bool?

Remarks

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

Default: - true, if email is turned on for signIn. false, otherwise.

Phone

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

bool? Phone { get; }

Property Value

bool?

Remarks

Default: - true, if phone is turned on for signIn. false, otherwise.