Class CfnSMSChannel

A channel is a type of platform that you can deliver messages to.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnSMSChannel
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSMSChannel : CfnResource, IInspectable
Syntax (vb)
Public Class CfnSMSChannel
    Inherits CfnResource
    Implements IInspectable
Remarks

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.

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

CloudformationResource: AWS::Pinpoint::SMSChannel

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 cfnSMSChannel = new CfnSMSChannel(this, "MyCfnSMSChannel", new CfnSMSChannelProps {
    ApplicationId = "applicationId",

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

Synopsis

Constructors

CfnSMSChannel(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnSMSChannel(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnSMSChannel(Construct, String, ICfnSMSChannelProps)

Properties

ApplicationId

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

(Deprecated) An identifier for the SMS channel.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnSMSChannel(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnSMSChannel(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnSMSChannel(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnSMSChannel(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnSMSChannel(Construct, String, ICfnSMSChannelProps)

public CfnSMSChannel(Construct scope, string id, ICfnSMSChannelProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnSMSChannelProps

Resource properties.

Properties

ApplicationId

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

public virtual string ApplicationId { get; set; }
Property Value

System.String

AttrId

(Deprecated) An identifier for the SMS channel.

public virtual string AttrId { get; }
Property Value

System.String

Remarks

This property is retained only for backward compatibility.

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Enabled

Specifies whether to enable the SMS channel for the application.

public virtual object Enabled { get; set; }
Property Value

System.Object

SenderId

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

public virtual string SenderId { get; set; }
Property Value

System.String

ShortCode

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

public virtual string ShortCode { get; set; }
Property Value

System.String

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements