Class CfnSMSChannelProps

Properties for defining a CfnSMSChannel.

Inheritance

object

CfnSMSChannelProps

Implements

ICfnSMSChannelProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSMSChannelProps : ICfnSMSChannelProps

Syntax (vb)

Public Class CfnSMSChannelProps Implements ICfnSMSChannelProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Pinpoint;

             var cfnSMSChannelProps = new CfnSMSChannelProps {
                 ApplicationId = "applicationId",

                 // the properties below are optional
                 Enabled = false,
                 SenderId = "senderId",
                 ShortCode = "shortCode"
             };

Synopsis

Constructors

CfnSMSChannelProps()

Properties for defining a CfnSMSChannel.

Properties

ApplicationId	The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
Enabled	Specifies whether to enable the SMS channel for the application.
SenderId	The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
ShortCode	The registered short code that you want to use when you send messages through the SMS channel.

Constructors

CfnSMSChannelProps()

Properties for defining a CfnSMSChannel.

public CfnSMSChannelProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Pinpoint;

             var cfnSMSChannelProps = new CfnSMSChannelProps {
                 ApplicationId = "applicationId",

                 // the properties below are optional
                 Enabled = false,
                 SenderId = "senderId",
                 ShortCode = "shortCode"
             };

Properties

ApplicationId

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

public string ApplicationId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-applicationid

Enabled

Specifies whether to enable the SMS channel for the application.

public object? Enabled { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-enabled

Type union: either bool or IResolvable

SenderId

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

public string? SenderId { get; set; }

Property Value

string

Remarks

SenderIDs are only supported in certain countries and regions. For more information, see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html">Supported Countries and Regions</a> in the <em>Amazon Pinpoint User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-senderid

ShortCode

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

public string? ShortCode { get; set; }

Property Value

string

Remarks

For information about obtaining a dedicated short code for sending SMS messages, see <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-short-code.html">Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint</a> in the <em>Amazon Pinpoint User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-shortcode

Implements

ICfnSMSChannelProps