AWS::Pinpoint::EmailTemplate - AWS CloudFormation

AWS::Pinpoint::EmailTemplate

The AWS::Pinpoint::EmailTemplate resource is a message template that you can use in messages that are sent through the email channel. A message template is a set of content and settings that you can define, save, and reuse in messages for one or more Amazon Pinpoint applications.

Syntax

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

JSON

{ "Type" : "AWS::Pinpoint::EmailTemplate", "Properties" : { "DefaultSubstitutions" : String, "HtmlPart" : String, "Subject" : String, "Tags" : Json, "TemplateDescription" : String, "TemplateName" : String, "TextPart" : String } }

YAML

Type: AWS::Pinpoint::EmailTemplate Properties: DefaultSubstitutions: String HtmlPart: String Subject: String Tags: Json TemplateDescription: String TemplateName: String TextPart: String

Properties

DefaultSubstitutions

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.

Required: No

Type: String

Update requires: No interruption

HtmlPart

The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.

Required: No

Type: String

Update requires: No interruption

Subject

The subject line, or title, to use in email messages that are based on the message template.

Required: Yes

Type: String

Update requires: No interruption

Tags

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Required: No

Type: Json

Update requires: No interruption

TemplateDescription

A custom description of the message template.

Required: No

Type: String

Update requires: No interruption

TemplateName

The name of the message template.

Required: Yes

Type: String

Update requires: Replacement

TextPart

The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.

Required: No

Type: String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the message template (TemplateName).

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the message template.