AWS::Cognito::UserPool VerificationMessageTemplate

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "DefaultEmailOption" : String,
  "EmailMessage" : String,
  "EmailMessageByLink" : String,
  "EmailSubject" : String,
  "EmailSubjectByLink" : String,
  "SmsMessage" : String
}

YAML

  DefaultEmailOption: String
  EmailMessage: String
  EmailMessageByLink: String
  EmailSubject: String
  EmailSubjectByLink: String
  SmsMessage: String

Properties

DefaultEmailOption

The configuration of verification emails to contain a clickable link or a verification code.

For link, your template body must contain link text in the format {##Click here##}. "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####}.

Required: No

Type: String

Allowed values: CONFIRM_WITH_LINK | CONFIRM_WITH_CODE

Update requires: No interruption

EmailMessage

The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Required: No

Type: String

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*

Minimum: 6

Maximum: 20000

Update requires: No interruption

EmailMessageByLink

The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Required: No

Type: String

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{##[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*##\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*

Minimum: 6

Maximum: 20000

Update requires: No interruption

EmailSubject

The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Required: No

Type: String

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+

Minimum: 1

Maximum: 140

Update requires: No interruption

EmailSubjectByLink

The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.

Required: No

Type: String

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\s]+

Minimum: 1

Maximum: 140

Update requires: No interruption

SmsMessage

The template for SMS messages that Amazon Cognito sends to your users.

Required: No

Type: String

Pattern: .*\{####\}.*

Minimum: 6

Maximum: 140

Update requires: No interruption