AWS Amazon Pinpoint SMS Channel

This page shows how to write Terraform and CloudFormation for Amazon Pinpoint SMS Channel and write them securely.

aws_pinpoint_sms_channel (Terraform)

The SMS Channel in Amazon Pinpoint can be configured in Terraform with the resource name aws_pinpoint_sms_channel. The following sections describe 1 example of how to use the resource and its parameters.

Example Usage from GitHub

main.tf#L7
resource "aws_pinpoint_sms_channel" "this" {
  application_id = var.application_id
  enabled        = var.enabled
  sender_id      = var.sender_id
  short_code     = var.short_code
}

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

Explanation in Terraform Registry

Provides a Pinpoint SMS Channel resource.

AWS::Pinpoint::SMSChannel (CloudFormation)

The SMSChannel in Pinpoint can be configured in CloudFormation with the resource name AWS::Pinpoint::SMSChannel. The following sections describe 8 examples of how to use the resource and its parameters.

Example Usage from GitHub

serverless.yml#L42
      Type: AWS::Pinpoint::SMSChannel
      Properties:
        ApplicationId: !Ref PinpointApplication
        Enabled: true

custom:
pinpoint.serverless.yml#L39
      Type: AWS::Pinpoint::SMSChannel
      Properties:
        ApplicationId:
          Ref: PinpointApp
        Enabled: true
        # ShortCode: String
pinpoint.yml#L20
    Type: AWS::Pinpoint::SMSChannel
    Properties:
      ApplicationId: !Ref pinpointApp
      Enabled: true

  pinpointEmailChannel:
pinpoint.yml#L18
    Type: AWS::Pinpoint::SMSChannel
    Properties:
      ApplicationId: !Ref PinpointApp
      Enabled: True

  # IAM role used by pinpoint to submit email open/click data to... pinpoint
pinpoint.yml#L18
    Type: AWS::Pinpoint::SMSChannel
    Properties:
      ApplicationId: !Ref PinpointApp
      Enabled: True

  # IAM role used by pinpoint to submit email open/click data to... pinpoint
awsResouceIconMatches.json#L568
        "resourceType": "AWS::Pinpoint::SMSChannel",
        "filePath": "icons/aws/Service/Arch_Mobile/64/Arch_Amazon-Pinpoint_64@5x.png"
      },
      {
        "resourceType": "AWS::Pinpoint::VoiceChannel",
        "filePath": "icons/aws/Service/Arch_Mobile/64/Arch_Amazon-Pinpoint_64@5x.png"
template.json#L51
    "AWS::Pinpoint::SMSChannel": {
      "Type": "AWS::Pinpoint::SMSChannel",
      "Properties": {}
    },
    "AWS::Route53Resolver::ResolverQueryLoggingConfig": {
      "Type": "AWS::Route53Resolver::ResolverQueryLoggingConfig",
PinpointSMSChannelSpecification.json#L3
    "AWS::Pinpoint::SMSChannel": {
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html",
      "Properties": {
        "ShortCode": {
          "Required": false,
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-shortcode",

Parameters

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.
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.
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

Explanation in CloudFormation Registry

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.

Frequently asked questions

What is AWS Amazon Pinpoint SMS Channel?

AWS Amazon Pinpoint SMS Channel is a resource for Amazon Pinpoint of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.

Where can I find the example code for the AWS Amazon Pinpoint SMS Channel?

For Terraform, the niveklabs/aws source code example is useful. See the Terraform Example section for further details.

For CloudFormation, the ricokahler/microcenter-rtx-notifier, bcx-exa/open-source_micro-backend-identity and DEFRA/flood-xws-subscription-api source code examples are useful. See the CloudFormation Example section for further details.