Class CfnOptOutList

Creates a new opt-out list.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnOptOutList
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.SMSVOICE
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnOptOutList : CfnResource, IInspectable, IOptOutListRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnOptOutList Inherits CfnResource Implements IInspectable, IOptOutListRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

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.SMSVOICE;

             var cfnOptOutList = new CfnOptOutList(this, "MyCfnOptOutList", new CfnOptOutListProps {
                 OptOutListName = "optOutListName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnOptOutList(Construct, string, ICfnOptOutListProps?)

Create a new AWS::SMSVOICE::OptOutList.

Properties

AttrArn

The Amazon Resource Name (ARN) for the OptOutList .
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Creates a new opt-out list.
OptOutListName

The name of the OptOutList.
OptOutListRef

A reference to a OptOutList resource.
Tags

An array of tags (key and value pairs) to associate with the new OptOutList.

Methods

FromOptOutListArn(Construct, string, string)

Creates a new IOptOutListRef from an ARN.
FromOptOutListName(Construct, string, string)

Creates a new IOptOutListRef from a optOutListName.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

Creates a new opt-out list.

Constructors

CfnOptOutList(Construct, string, ICfnOptOutListProps?)

Create a new AWS::SMSVOICE::OptOutList.

public CfnOptOutList(Construct scope, string id, ICfnOptOutListProps? props = null)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnOptOutListProps

Resource properties.

Remarks

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) for the OptOutList .

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

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

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

ExampleMetadata: fixture=_generated

CfnProperties

Creates a new opt-out list.

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

IDictionary<string, object>

Overrides
Remarks

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

ExampleMetadata: fixture=_generated

OptOutListName

The name of the OptOutList.

public virtual string? OptOutListName { get; set; }
Property Value

string

Remarks

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

ExampleMetadata: fixture=_generated

OptOutListRef

A reference to a OptOutList resource.

public virtual IOptOutListReference OptOutListRef { get; }
Property Value

IOptOutListReference

Remarks

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

ExampleMetadata: fixture=_generated

Tags

An array of tags (key and value pairs) to associate with the new OptOutList.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

ExampleMetadata: fixture=_generated

Methods

FromOptOutListArn(Construct, string, string)

Creates a new IOptOutListRef from an ARN.

public static IOptOutListRef FromOptOutListArn(Construct scope, string id, string arn)
Parameters
scope Construct
id string
arn string
Returns

IOptOutListRef

Remarks

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

ExampleMetadata: fixture=_generated

FromOptOutListName(Construct, string, string)

Creates a new IOptOutListRef from a optOutListName.

public static IOptOutListRef FromOptOutListName(Construct scope, string id, string optOutListName)
Parameters
scope Construct
id string
optOutListName string
Returns

IOptOutListRef

Remarks

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

ExampleMetadata: fixture=_generated

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

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a new opt-out list.

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

IDictionary<string, object>

Overrides
Remarks

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

CloudformationResource: AWS::SMSVOICE::OptOutList

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable