AWS::Cognito::UserPool VerificationMessageTemplate - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Cognito::UserPool VerificationMessageTemplate

The template for verification messages.

Syntax

To declare this entity in your Amazon 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 default email option.

Required: No

Type: String

Allowed values: CONFIRM_WITH_CODE | CONFIRM_WITH_LINK

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

Minimum: 6

Maximum: 20000

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

Update requires: No interruption

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

Minimum: 6

Maximum: 20000

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*]*

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

Minimum: 1

Maximum: 140

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

Update requires: No interruption

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

Minimum: 1

Maximum: 140

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

Update requires: No interruption

SmsMessage

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

Required: No

Type: String

Minimum: 6

Maximum: 140

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

Update requires: No interruption