AWS::Pinpoint::SmsTemplate - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Pinpoint::SmsTemplate

Creates a message template that you can use in messages that are sent through the SMS channel. A message template is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

Syntax

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

JSON

{
  "Type" : "AWS::Pinpoint::SmsTemplate",
  "Properties" : {
      "Body" : String,
      "DefaultSubstitutions" : String,
      "Tags" : [ Tag, ... ],
      "TemplateDescription" : String,
      "TemplateName" : String
    }
}

YAML

Type: AWS::Pinpoint::SmsTemplate
Properties:
  Body: String
  DefaultSubstitutions: String
  Tags: 
    - Tag
  TemplateDescription: String
  TemplateName: String

Properties

Body

The message body to use in text messages that are based on the message template.

Required: Yes

Type: String

Update requires: No interruption

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

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

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 to use for the message. If specified, this value must match the name of an existing message template.

Required: Yes

Type: String

Update requires: Replacement

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.