CfnPoolProps

class aws_cdk.aws_smsvoice.CfnPoolProps(*, mandatory_keywords, origination_identities, deletion_protection_enabled=None, optional_keywords=None, opt_out_list_name=None, self_managed_opt_outs_enabled=None, shared_routes_enabled=None, tags=None, two_way=None)

Bases: object

Properties for defining a CfnPool.

Parameters:

mandatory_keywords (Union[IResolvable, MandatoryKeywordsProperty, Dict[str, Any]]) – Creates or updates the pool’s MandatoryKeyword configuration. For more information, see Keywords in the End User Messaging User Guide.
origination_identities (Sequence[str]) – The list of origination identities to apply to the pool, either PhoneNumberArn or SenderIdArn . For more information, see Registrations in the End User Messaging User Guide. .. epigraph:: If you are using a shared End User Messaging resource then you must use the full Amazon Resource Name (ARN).
deletion_protection_enabled (Union[bool, IResolvable, None]) – When set to true the pool can’t be deleted.
optional_keywords (Union[IResolvable, Sequence[Union[IResolvable, OptionalKeywordProperty, Dict[str, Any]]], None]) –
Specifies any optional keywords to associate with the pool. 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 pool.
self_managed_opt_outs_enabled (Union[bool, IResolvable, None]) – When set to false, 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 requests. For more information see Self-managed opt-outs
shared_routes_enabled (Union[bool, IResolvable, None]) – Allows you to enable shared routes on your pool. By default, this is set to False . If you set this value to True , your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren’t allowed to use shared routes and must use a dedicated phone number or short code.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of tags (key and value pairs) associated with the pool.
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-pool.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_pool_props = smsvoice.CfnPoolProps(
    mandatory_keywords=smsvoice.CfnPool.MandatoryKeywordsProperty(
        help=smsvoice.CfnPool.MandatoryKeywordProperty(
            message="message"
        ),
        stop=smsvoice.CfnPool.MandatoryKeywordProperty(
            message="message"
        )
    ),
    origination_identities=["originationIdentities"],

    # the properties below are optional
    deletion_protection_enabled=False,
    optional_keywords=[smsvoice.CfnPool.OptionalKeywordProperty(
        action="action",
        keyword="keyword",
        message="message"
    )],
    opt_out_list_name="optOutListName",
    self_managed_opt_outs_enabled=False,
    shared_routes_enabled=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    two_way=smsvoice.CfnPool.TwoWayProperty(
        enabled=False,

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

Attributes

deletion_protection_enabled

When set to true the pool can’t be deleted.

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

mandatory_keywords

Creates or updates the pool’s MandatoryKeyword configuration.

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

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

opt_out_list_name

The name of the OptOutList associated with the pool.

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

optional_keywords

Specifies any optional keywords to associate with the pool.

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

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

origination_identities

The list of origination identities to apply to the pool, either PhoneNumberArn or SenderIdArn .

For more information, see Registrations in the End User Messaging User Guide. .. epigraph:

If you are using a shared End User Messaging  resource then you must use the full Amazon Resource Name (ARN).

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

self_managed_opt_outs_enabled

When set to false, 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 requests. For more information see Self-managed opt-outs

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

shared_routes_enabled

Allows you to enable shared routes on your pool.

By default, this is set to False . If you set this value to True , your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren’t allowed to use shared routes and must use a dedicated phone number or short code.

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

tags

An array of tags (key and value pairs) associated with the pool.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html#cfn-smsvoice-pool-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-pool.html#cfn-smsvoice-pool-twoway