CfnPhoneNumberPropsMixin

class aws_cdk.mixins_preview.aws_smsvoice.mixins.CfnPhoneNumberPropsMixin(props, *, strategy=None)

Bases: Mixin

Request an origination phone number for use in your account.

For more information on phone number request see Request a phone number in the End User Messaging User Guide . .. epigraph:

Registering phone numbers is not supported by AWS CloudFormation . You can import phone numbers and sender IDs that are automatically provisioned at registration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html
CloudformationResource:: AWS::SMSVOICE::PhoneNumber
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_smsvoice import mixins as smsvoice_mixins

cfn_phone_number_props_mixin = smsvoice_mixins.CfnPhoneNumberPropsMixin(smsvoice_mixins.CfnPhoneNumberMixinProps(
    deletion_protection_enabled=False,
    iso_country_code="isoCountryCode",
    mandatory_keywords=smsvoice_mixins.CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty(
        help=smsvoice_mixins.CfnPhoneNumberPropsMixin.MandatoryKeywordProperty(
            message="message"
        ),
        stop=smsvoice_mixins.CfnPhoneNumberPropsMixin.MandatoryKeywordProperty(
            message="message"
        )
    ),
    number_capabilities=["numberCapabilities"],
    number_type="numberType",
    optional_keywords=[smsvoice_mixins.CfnPhoneNumberPropsMixin.OptionalKeywordProperty(
        action="action",
        keyword="keyword",
        message="message"
    )],
    opt_out_list_name="optOutListName",
    self_managed_opt_outs_enabled=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    two_way=smsvoice_mixins.CfnPhoneNumberPropsMixin.TwoWayProperty(
        channel_arn="channelArn",
        channel_role="channelRole",
        enabled=False
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SMSVOICE::PhoneNumber.

Parameters:

props (Union[CfnPhoneNumberMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['deletionProtectionEnabled', 'isoCountryCode', 'mandatoryKeywords', 'numberCapabilities', 'numberType', 'optionalKeywords', 'optOutListName', 'selfManagedOptOutsEnabled', 'tags', 'twoWay']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

MandatoryKeywordProperty

class CfnPhoneNumberPropsMixin.MandatoryKeywordProperty(*, message=None)

Bases: object

The keywords HELP and STOP are mandatory keywords that each phone number must have.

For more information, see Keywords in the End User Messaging User Guide.

Parameters:: message (Optional[str]) – The message associated with the keyword.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeyword.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_smsvoice import mixins as smsvoice_mixins

mandatory_keyword_property = smsvoice_mixins.CfnPhoneNumberPropsMixin.MandatoryKeywordProperty(
    message="message"
)

Attributes

message

The message associated with the keyword.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeyword.html#cfn-smsvoice-phonenumber-mandatorykeyword-message

MandatoryKeywordsProperty

class CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty(*, help=None, stop=None)

Bases: object

The keywords HELP and STOP are mandatory keywords that each phone number must have.

For more information, see Keywords in the End User Messaging User Guide.

Parameters:

help (Union[IResolvable, MandatoryKeywordProperty, Dict[str, Any], None]) –
Specifies the HELP keyword that customers use to obtain customer support for this phone number. For more information, see Keywords in the End User Messaging User Guide.
stop (Union[IResolvable, MandatoryKeywordProperty, Dict[str, Any], None]) – Specifies the STOP keyword that customers use to opt out of receiving messages from this phone number. For more information, see Required opt-out keywords in the End User Messaging User Guide.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-mandatorykeywords.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_smsvoice import mixins as smsvoice_mixins

mandatory_keywords_property = smsvoice_mixins.CfnPhoneNumberPropsMixin.MandatoryKeywordsProperty(
    help=smsvoice_mixins.CfnPhoneNumberPropsMixin.MandatoryKeywordProperty(
        message="message"
    ),
    stop=smsvoice_mixins.CfnPhoneNumberPropsMixin.MandatoryKeywordProperty(
        message="message"
    )
)

Attributes

help

Specifies the HELP keyword that customers use to obtain customer support for this phone number.

For more information, see Keywords in the End User Messaging User Guide.

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

stop

Specifies the STOP keyword that customers use to opt out of receiving messages from this phone number.

For more information, see Required opt-out keywords in the End User Messaging User Guide.

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

OptionalKeywordProperty

class CfnPhoneNumberPropsMixin.OptionalKeywordProperty(*, action=None, keyword=None, message=None)

Bases: object

The OptionalKeyword configuration.

For more information, see Keywords in the End User Messaging User Guide.

Parameters:

action (Optional[str]) – The action to perform when the keyword is used.
keyword (Optional[str]) – The new keyword to add.
message (Optional[str]) – The message associated with the keyword.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_smsvoice import mixins as smsvoice_mixins

optional_keyword_property = smsvoice_mixins.CfnPhoneNumberPropsMixin.OptionalKeywordProperty(
    action="action",
    keyword="keyword",
    message="message"
)

Attributes

action

The action to perform when the keyword is used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-action

keyword

The new keyword to add.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-keyword

message

The message associated with the keyword.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-optionalkeyword.html#cfn-smsvoice-phonenumber-optionalkeyword-message

TwoWayProperty

class CfnPhoneNumberPropsMixin.TwoWayProperty(*, channel_arn=None, channel_role=None, enabled=None)

Bases: object

The phone number’s two-way SMS configuration object.

Parameters:

channel_arn (Optional[str]) – The Amazon Resource Name (ARN) of the two way channel.
channel_role (Optional[str]) – An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
enabled (Union[bool, IResolvable, None]) – By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-phonenumber-twoway.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_smsvoice import mixins as smsvoice_mixins

two_way_property = smsvoice_mixins.CfnPhoneNumberPropsMixin.TwoWayProperty(
    channel_arn="channelArn",
    channel_role="channelRole",
    enabled=False
)

Attributes

channel_arn

The Amazon Resource Name (ARN) of the two way channel.

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

channel_role

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

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

enabled

By default this is set to false.

When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

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