Class CfnSMSChannel
A CloudFormation AWS::Pinpoint::SMSChannel
.
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.AWS.Pinpoint.dll
Syntax (csharp)
public class CfnSMSChannel : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSMSChannel
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::Pinpoint::SMSChannel
Link: 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 cfnSMSChannel = new CfnSMSChannel(this, "MyCfnSMSChannel", new CfnSMSChannelProps {
ApplicationId = "applicationId",
// the properties below are optional
Enabled = false,
SenderId = "senderId",
ShortCode = "shortCode"
});
Synopsis
Constructors
CfnSMSChannel(Construct, String, ICfnSMSChannelProps) | Create a new |
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 |
Properties
ApplicationId | The unique identifier for the Amazon Pinpoint application that the SMS channel applies to. |
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(Construct, String, ICfnSMSChannelProps)
Create a new AWS::Pinpoint::SMSChannel
.
public CfnSMSChannel(Construct scope, string id, ICfnSMSChannelProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSMSChannelProps
- resource properties.
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
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
Remarks
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
Remarks
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
Remarks
SenderIDs are only supported in certain countries and regions. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide .
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
Remarks
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 .
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>