AWS::Pinpoint::SMSChannelCfnSMSChannel
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.
Import
import { CfnSMSChannel } from 'aws-cdk-lib/aws-pinpoint';Or use the module namespace:
import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';
// pinpoint.CfnSMSChannelProperties
Configuration passed to the constructor as CfnSMSChannelProps.
applicationIdRequiredstringThe unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
enabledOptionalboolean | IResolvableSpecifies whether to enable the SMS channel for the application.
senderIdOptionalstringThe 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](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html) in the *Amazon Pinpoint User Guide* .
shortCodeOptionalstringThe 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](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-short-code.html) in the *Amazon Pinpoint User Guide* .
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-pinpointAWS::Pinpoint::SMSChannel