AWS Amazon Pinpoint SMS Channel

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

code-icon

Fix issues in your cloud & app configurations

Test for misconfigurations of this resource in your cloud.

get-started-button

Terraform Example (aws_pinpoint_sms_channel)

Provides a Pinpoint SMS Channel resource.

Parameters

Example Usage (from GitHub)

github-iconniveklabs/aws
resource "aws_pinpoint_sms_channel" "this" {
  application_id = var.application_id
  enabled        = var.enabled
  sender_id      = var.sender_id
  short_code     = var.short_code
}

CloudFormation Example (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.

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

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.