AWS::Pinpoint::Campaign CampaignSmsMessage - 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::Pinpoint::Campaign CampaignSmsMessage

Specifies the content and settings for an SMS message that's sent to recipients of a campaign.

Syntax

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

JSON

{
  "Body" : String,
  "EntityId" : String,
  "MessageType" : String,
  "OriginationNumber" : String,
  "SenderId" : String,
  "TemplateId" : String
}

YAML

  Body: String
  EntityId: String
  MessageType: String
  OriginationNumber: String
  SenderId: String
  TemplateId: String

Properties

Body

The body of the SMS message.

Required: No

Type: String

Update requires: No interruption

EntityId

The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.

Required: No

Type: String

Update requires: No interruption

MessageType

The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).

Required: No

Type: String

Update requires: No interruption

OriginationNumber

The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your Amazon account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.

Required: No

Type: String

Update requires: No interruption

SenderId

The alphabetic Sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. To specify a phone number as the sender, omit this parameter and use OriginationNumber instead. For more information about support for Sender ID by country, see the Amazon Pinpoint User Guide.

Required: No

Type: String

Update requires: No interruption

TemplateId

The template ID received from the regulatory body for sending SMS in your country.

Required: No

Type: String

Update requires: No interruption