AWS::Pinpoint::SMSChannel

A channel is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you can use Amazon Pinpoint to send text messages, you have to enable the SMS channel for an Amazon Pinpoint application.

The SMSChannel resource represents the status, sender ID, and other settings for the SMS channel for an application.

Syntax

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

JSON

{
  "Type" : "AWS::Pinpoint::SMSChannel",
  "Properties" : {
      "ApplicationId" : String,
      "Enabled" : Boolean,
      "SenderId" : String,
      "ShortCode" : String
    }
}

YAML

Type: AWS::Pinpoint::SMSChannel
Properties:
  ApplicationId: String
  Enabled: Boolean
  SenderId: String
  ShortCode: String

Properties

ApplicationId

The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.

Required: Yes

Type: String

Update requires: Replacement

Enabled

Specifies whether to enable the SMS channel for the application.

Required: No

Type: Boolean

Update requires: No interruption

SenderId

The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

Note

SenderIDs are only supported in certain countries and regions. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.

Required: No

Type: String

Update requires: No interruption

ShortCode

The registered short code that you want to use when you send messages through the SMS channel.

Note

For information about obtaining a dedicated short code for sending SMS messages, see Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide.

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 unique identifier (ApplicationId) for the Amazon Pinpoint application that the channel is associated with.

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

Fn::GetAtt

Id

(Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.