CfnPhoneNumberProps

class aws_cdk.aws_smsvoice.CfnPhoneNumberProps(*, iso_country_code, mandatory_keywords, number_capabilities, number_type, deletion_protection_enabled=None, optional_keywords=None, opt_out_list_name=None, self_managed_opt_outs_enabled=None, tags=None, two_way=None)

Bases: object

Properties for defining a CfnPhoneNumber.

Parameters:

iso_country_code (str) – The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
mandatory_keywords (Union[IResolvable, MandatoryKeywordsProperty, Dict[str, Any]]) – Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.
number_capabilities (Sequence[str]) – Indicates if the phone number will be used for text messages, voice messages, or both.
number_type (str) – The type of phone number to request. .. epigraph:: The ShortCode number type is not supported in AWS CloudFormation .
deletion_protection_enabled (Union[bool, IResolvable, None]) – By default this is set to false. When set to true the phone number can’t be deleted.
optional_keywords (Union[IResolvable, Sequence[Union[IResolvable, OptionalKeywordProperty, Dict[str, Any]]], None]) –
A keyword is a word that you can search for on a particular phone number or pool. 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.
opt_out_list_name (Optional[str]) – The name of the OptOutList associated with the phone number.
self_managed_opt_outs_enabled (Union[bool, IResolvable, None]) – 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. 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
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of tags (key and value pairs) to associate with the requested phone number.
two_way (Union[IResolvable, TwoWayProperty, Dict[str, Any], None]) – Describes the two-way SMS configuration for a phone number. 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

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 import aws_smsvoice as smsvoice

cfn_phone_number_props = smsvoice.CfnPhoneNumberProps(
    iso_country_code="isoCountryCode",
    mandatory_keywords=smsvoice.CfnPhoneNumber.MandatoryKeywordsProperty(
        help=smsvoice.CfnPhoneNumber.MandatoryKeywordProperty(
            message="message"
        ),
        stop=smsvoice.CfnPhoneNumber.MandatoryKeywordProperty(
            message="message"
        )
    ),
    number_capabilities=["numberCapabilities"],
    number_type="numberType",

    # the properties below are optional
    deletion_protection_enabled=False,
    optional_keywords=[smsvoice.CfnPhoneNumber.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.CfnPhoneNumber.TwoWayProperty(
        enabled=False,

        # the properties below are optional
        channel_arn="channelArn",
        channel_role="channelRole"
    )
)

Attributes

deletion_protection_enabled

By default this is set to false.

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

iso_country_code

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

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

mandatory_keywords

Creates or updates a MandatoryKeyword configuration on an origination phone number 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-mandatorykeywords

number_capabilities

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

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

number_type

The type of phone number to request.

The ShortCode 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

opt_out_list_name

The name of the OptOutList associated with the phone number.

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

optional_keywords

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

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

self_managed_opt_outs_enabled

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.

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

tags

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

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

two_way

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

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