interface CfnSMSChannelProps

Language	Type name
.NET	`Amazon.CDK.AWS.Pinpoint.CfnSMSChannelProps`
Java	`software.amazon.awscdk.services.pinpoint.CfnSMSChannelProps`
Python	`aws_cdk.aws_pinpoint.CfnSMSChannelProps`
TypeScript	`@aws-cdk/aws-pinpoint` » `CfnSMSChannelProps`

Properties for defining a CfnSMSChannel.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pinpoint from '@aws-cdk/aws-pinpoint';
const cfnSMSChannelProps: pinpoint.CfnSMSChannelProps = {
  applicationId: 'applicationId',

  // the properties below are optional
  enabled: false,
  senderId: 'senderId',
  shortCode: 'shortCode',
};

Properties

Name	Type	Description
applicationId	`string`	The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
enabled?	`boolean \|` `IResolvable`	Specifies whether to enable the SMS channel for the application.
senderId?	`string`	The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
shortCode?	`string`	The registered short code that you want to use when you send messages through the SMS channel.

applicationId

Type: string

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

enabled?

Type: boolean | IResolvable (optional)

Specifies whether to enable the SMS channel for the application.

senderId?

Type: string (optional)

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 .

shortCode?

Type: string (optional)

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 .