AWS CloudFormation
User Guide (Version )

AWS::Cognito::UserPool InviteMessageTemplate

InviteMessageTemplate is a subproperty of the AdminCreateUserConfig property that defines the email and SMS invitation message structure of an Amazon Cognito User Pool.

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.

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

EmailSubject

The subject line for email messages.

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

Required: No

Type: String

Minimum: 6

Maximum: 140

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

Update requires: No interruption

On this page: