Class CfnSMSChannel

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnSMSChannel

Implements

IInspectable

ISMSChannelRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSMSChannel : CfnResource, IInspectable, ISMSChannelRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnSMSChannel Inherits CfnResource Implements IInspectable, ISMSChannelRef, IConstruct, IDependable, IEnvironmentAware

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(Construct, string, ICfnSMSChannelProps)

Create a new AWS::Pinpoint::SMSChannel.

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	A channel is a type of platform that you can deliver messages to.
CfnPropertyNames	A channel is a type of platform that you can deliver messages 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.
SmsChannelRef	A reference to a SMSChannel resource.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnSMSChannel(object)	Checks whether the given object is a CfnSMSChannel.
RenderProperties(IDictionary<string, object>)	A channel is a type of platform that you can deliver messages to.

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 string

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

props ICfnSMSChannelProps

Resource properties.

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

Properties

ApplicationId

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

public virtual string ApplicationId { get; set; }

Property Value

string

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

AttrId

(Deprecated) An identifier for the SMS channel.

public virtual string AttrId { get; }

Property Value

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

string

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

CfnProperties

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

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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

CfnPropertyNames

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

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

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

Enabled

Specifies whether to enable the SMS channel for the application.

public virtual object? Enabled { get; set; }

Property Value

object

Remarks

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 virtual string? SenderId { get; set; }

Property Value

string

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

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

string

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

SmsChannelRef

A reference to a SMSChannel resource.

public virtual ISMSChannelReference SmsChannelRef { get; }

Property Value

ISMSChannelReference

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

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.

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

IsCfnSMSChannel(object)

Checks whether the given object is a CfnSMSChannel.

public static bool IsCfnSMSChannel(object x)

Parameters

x object

Returns

bool

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

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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

Implements

IInspectable

ISMSChannelRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware