AutoVerifiedAttrs

class aws_cdk.aws_cognito.AutoVerifiedAttrs(*, email=None, phone=None)

Bases: object

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

Parameters:

email (Optional[bool]) – 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 Default: - true, if email is turned on for signIn. false, otherwise.
phone (Optional[bool]) – Whether the phone number of the user should be auto verified at sign up. Default: - true, if phone is turned on for signIn. false, otherwise.

ExampleMetadata:

infused

Example:

cognito.UserPool(self, "myuserpool",
    # ...
    # ...
    sign_in_aliases=cognito.SignInAliases(username=True, email=True),
    auto_verify=cognito.AutoVerifiedAttrs(email=True, phone=True)
)

Attributes

email

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