UserVerificationConfig

class aws_cdk.aws_cognito.UserVerificationConfig(*, email_body=None, email_style=None, email_subject=None, sms_message=None)

Bases: object

__init__(*, email_body=None, email_style=None, email_subject=None, sms_message=None)

User pool configuration for user self sign up.

Parameters

stability :stability: experimental

Return type

None

Attributes

email_body

The email body template for the verification email sent to the user upon sign up.

See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.

default :default:

  • ‘The verification code to your new account is {####}’ if VerificationEmailStyle.CODE is chosen, ‘Verify your account by clicking on {##Verify Email##}’ if VerificationEmailStyle.LINK is chosen.

stability :stability: experimental

Return type

Optional[str]

email_style

Emails can be verified either using a code or a link.

Learn more at https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-email-verification-message-customization.html

default :default: VerificationEmailStyle.CODE

stability :stability: experimental

Return type

Optional[VerificationEmailStyle]

email_subject

The email subject template for the verification email sent to the user upon sign up.

See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.

default :default: ‘Verify your new account’

stability :stability: experimental

Return type

Optional[str]

sms_message

The message template for the verification SMS sent to the user upon sign up.

See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.

default :default:

  • ‘The verification code to your new account is {####}’ if VerificationEmailStyle.CODE is chosen, not configured if VerificationEmailStyle.LINK is chosen

stability :stability: experimental

Return type

Optional[str]