CfnPoolPropsMixin

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

Bases: Mixin

Creates a new pool and associates the specified origination identity to the pool.

A pool can include one or more phone numbers and SenderIds that are associated with your AWS account.

The new pool inherits its configuration from the specified origination identity. This includes keywords, message type, opt-out list, two-way configuration, and self-managed opt-out configuration. Deletion protection isn’t inherited from the origination identity and defaults to false.

If the origination identity is a phone number and is already associated with another pool, an error is returned. A sender ID can be associated with multiple pools.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-pool.html
CloudformationResource:: AWS::SMSVOICE::Pool
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_pool_props_mixin = smsvoice_mixins.CfnPoolPropsMixin(smsvoice_mixins.CfnPoolMixinProps(
    deletion_protection_enabled=False,
    mandatory_keywords=smsvoice_mixins.CfnPoolPropsMixin.MandatoryKeywordsProperty(
        help=smsvoice_mixins.CfnPoolPropsMixin.MandatoryKeywordProperty(
            message="message"
        ),
        stop=smsvoice_mixins.CfnPoolPropsMixin.MandatoryKeywordProperty(
            message="message"
        )
    ),
    optional_keywords=[smsvoice_mixins.CfnPoolPropsMixin.OptionalKeywordProperty(
        action="action",
        keyword="keyword",
        message="message"
    )],
    opt_out_list_name="optOutListName",
    origination_identities=["originationIdentities"],
    self_managed_opt_outs_enabled=False,
    shared_routes_enabled=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    two_way=smsvoice_mixins.CfnPoolPropsMixin.TwoWayProperty(
        channel_arn="channelArn",
        channel_role="channelRole",
        enabled=False
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnPoolMixinProps, 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', 'mandatoryKeywords', 'optionalKeywords', 'optOutListName', 'originationIdentities', 'selfManagedOptOutsEnabled', 'sharedRoutesEnabled', '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 CfnPoolPropsMixin.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-pool-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.CfnPoolPropsMixin.MandatoryKeywordProperty(
    message="message"
)

Attributes

message

The message associated with the keyword.

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

MandatoryKeywordsProperty

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

Bases: object

The manadatory keywords, HELP and STOP to add to the pool.

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

Parameters:

help (Union[IResolvable, MandatoryKeywordProperty, Dict[str, Any], None]) – Specifies the pool’s HELP keyword. For more information, see Opt out list required keywords in the End User Messaging User Guide.
stop (Union[IResolvable, MandatoryKeywordProperty, Dict[str, Any], None]) – Specifies the pool’s opt-out keyword. 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-pool-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.CfnPoolPropsMixin.MandatoryKeywordsProperty(
    help=smsvoice_mixins.CfnPoolPropsMixin.MandatoryKeywordProperty(
        message="message"
    ),
    stop=smsvoice_mixins.CfnPoolPropsMixin.MandatoryKeywordProperty(
        message="message"
    )
)

Attributes

help

Specifies the pool’s HELP keyword.

For more information, see Opt out list required keywords in the End User Messaging User Guide.

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

stop

Specifies the pool’s opt-out keyword.

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-pool-mandatorykeywords.html#cfn-smsvoice-pool-mandatorykeywords-stop

OptionalKeywordProperty

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

Bases: object

The pool’s 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-pool-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.CfnPoolPropsMixin.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-pool-optionalkeyword.html#cfn-smsvoice-pool-optionalkeyword-action

keyword

The new keyword to add.

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

message

The message associated with the keyword.

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

TwoWayProperty

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

Bases: object

The pool’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-pool-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.CfnPoolPropsMixin.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-pool-twoway.html#cfn-smsvoice-pool-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-pool-twoway.html#cfn-smsvoice-pool-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-pool-twoway.html#cfn-smsvoice-pool-twoway-enabled