Class CfnPhoneNumberMixinProps

Properties for CfnPhoneNumberPropsMixin.

Inheritance

object

CfnPhoneNumberMixinProps

Implements

ICfnPhoneNumberMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.SMSVOICE

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnPhoneNumberMixinProps : ICfnPhoneNumberMixinProps

Syntax (vb)

Public Class CfnPhoneNumberMixinProps Implements ICfnPhoneNumberMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.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.CfnPropertyMixins.AWS.SMSVOICE;

             var cfnPhoneNumberMixinProps = new CfnPhoneNumberMixinProps {
                 DeletionProtectionEnabled = false,
                 IsoCountryCode = "isoCountryCode",
                 MandatoryKeywords = new MandatoryKeywordsProperty {
                     Help = new MandatoryKeywordProperty {
                         Message = "message"
                     },
                     Stop = new MandatoryKeywordProperty {
                         Message = "message"
                     }
                 },
                 NumberCapabilities = new [] { "numberCapabilities" },
                 NumberType = "numberType",
                 OptionalKeywords = new [] { new OptionalKeywordProperty {
                     Action = "action",
                     Keyword = "keyword",
                     Message = "message"
                 } },
                 OptOutListName = "optOutListName",
                 SelfManagedOptOutsEnabled = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TwoWay = new TwoWayProperty {
                     ChannelArn = "channelArn",
                     ChannelRole = "channelRole",
                     Enabled = false
                 }
             };

Synopsis

Constructors

CfnPhoneNumberMixinProps()

Properties for CfnPhoneNumberPropsMixin.

Properties

DeletionProtectionEnabled	By default this is set to false.
IsoCountryCode	The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
MandatoryKeywords	Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.
NumberCapabilities	Indicates if the phone number will be used for text messages, voice messages, or both.
NumberType	The type of phone number to request.
OptOutListName	The name of the OptOutList associated with the phone number.
OptionalKeywords	A keyword is a word that you can search for on a particular phone number or pool.
SelfManagedOptOutsEnabled	When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList.
Tags	An array of tags (key and value pairs) to associate with the requested phone number.
TwoWay	Describes the two-way SMS configuration for a phone number.

Constructors

CfnPhoneNumberMixinProps()

Properties for CfnPhoneNumberPropsMixin.

public CfnPhoneNumberMixinProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.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.CfnPropertyMixins.AWS.SMSVOICE;

             var cfnPhoneNumberMixinProps = new CfnPhoneNumberMixinProps {
                 DeletionProtectionEnabled = false,
                 IsoCountryCode = "isoCountryCode",
                 MandatoryKeywords = new MandatoryKeywordsProperty {
                     Help = new MandatoryKeywordProperty {
                         Message = "message"
                     },
                     Stop = new MandatoryKeywordProperty {
                         Message = "message"
                     }
                 },
                 NumberCapabilities = new [] { "numberCapabilities" },
                 NumberType = "numberType",
                 OptionalKeywords = new [] { new OptionalKeywordProperty {
                     Action = "action",
                     Keyword = "keyword",
                     Message = "message"
                 } },
                 OptOutListName = "optOutListName",
                 SelfManagedOptOutsEnabled = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TwoWay = new TwoWayProperty {
                     ChannelArn = "channelArn",
                     ChannelRole = "channelRole",
                     Enabled = false
                 }
             };

Properties

DeletionProtectionEnabled

By default this is set to false.

public object? DeletionProtectionEnabled { get; set; }

Property Value

object

Remarks

When set to true the phone number can't be deleted.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-deletionprotectionenabled

Type union: either bool or IResolvable

IsoCountryCode

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

public string? IsoCountryCode { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-isocountrycode

MandatoryKeywords

Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.

public object? MandatoryKeywords { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-mandatorykeywords

Type union: either IResolvable or CfnPhoneNumberPropsMixin.IMandatoryKeywordsProperty

NumberCapabilities

Indicates if the phone number will be used for text messages, voice messages, or both.

public string[]? NumberCapabilities { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-numbercapabilities

NumberType

The type of phone number to request.

public string? NumberType { get; set; }

Property Value

string

Remarks

The <code>ShortCode</code> number type is not supported in AWS CloudFormation .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-numbertype

OptOutListName

The name of the OptOutList associated with the phone number.

public string? OptOutListName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-optoutlistname

OptionalKeywords

A keyword is a word that you can search for on a particular phone number or pool.

public object? OptionalKeywords { get; set; }

Property Value

object

Remarks

It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User Messaging responds with a customizable message. Optional keywords are differentiated from mandatory keywords. For more information, see Keywords in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-optionalkeywords

Type union: either IResolvable or (either IResolvable or CfnPhoneNumberPropsMixin.IOptionalKeywordProperty)[]

SelfManagedOptOutsEnabled

When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging automatically replies with a customizable message and adds the end recipient to the OptOutList.

public object? SelfManagedOptOutsEnabled { get; set; }

Property Value

object

Remarks

When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-selfmanagedoptoutsenabled

Type union: either bool or IResolvable

Tags

An array of tags (key and value pairs) to associate with the requested phone number.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-tags

TwoWay

Describes the two-way SMS configuration for a phone number.

public object? TwoWay { get; set; }

Property Value

object

Remarks

For more information, see Two-way SMS messaging in the End User Messaging User Guide.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-twoway

Type union: either IResolvable or CfnPhoneNumberPropsMixin.ITwoWayProperty

Implements

ICfnPhoneNumberMixinProps