AWS::Cognito::UserPool InviteMessageTemplate - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Cognito::UserPool InviteMessageTemplate

The template for the welcome message to new users. This template must include the {####} temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.

See also Customizing User Invitation Messages.

Syntax

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

JSON

{
  "EmailMessage" : String,
  "EmailSubject" : String,
  "SMSMessage" : String
}

YAML

  EmailMessage: String
  EmailSubject: String
  SMSMessage: String

Properties

EmailMessage

The message template for email messages. EmailMessage is allowed only if EmailSendingAccount is DEVELOPER.

Required: No

Type: String

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

Minimum: 6

Maximum: 20000

Update requires: No interruption

EmailSubject

The subject line for email messages. EmailSubject is allowed only if EmailSendingAccount is DEVELOPER.

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 message template for SMS messages.

Required: No

Type: String

Pattern: (?s).*

Minimum: 6

Maximum: 140

Update requires: No interruption