CfnProtectConfigurationPropsMixin

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

Bases: Mixin

Create a new protect configuration.

By default all country rule sets for each capability are set to ALLOW . A protect configurations name is stored as a Tag with the key set to Name and value as the name of the protect configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-protectconfiguration.html
CloudformationResource:: AWS::SMSVOICE::ProtectConfiguration
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_protect_configuration_props_mixin = smsvoice_mixins.CfnProtectConfigurationPropsMixin(smsvoice_mixins.CfnProtectConfigurationMixinProps(
    country_rule_set=smsvoice_mixins.CfnProtectConfigurationPropsMixin.CountryRuleSetProperty(
        mms=[smsvoice_mixins.CfnProtectConfigurationPropsMixin.CountryRuleProperty(
            country_code="countryCode",
            protect_status="protectStatus"
        )],
        sms=[smsvoice_mixins.CfnProtectConfigurationPropsMixin.CountryRuleProperty(
            country_code="countryCode",
            protect_status="protectStatus"
        )],
        voice=[smsvoice_mixins.CfnProtectConfigurationPropsMixin.CountryRuleProperty(
            country_code="countryCode",
            protect_status="protectStatus"
        )]
    ),
    deletion_protection_enabled=False,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnProtectConfigurationMixinProps, 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 = ['countryRuleSet', 'deletionProtectionEnabled', 'tags']

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

CountryRuleProperty

class CfnProtectConfigurationPropsMixin.CountryRuleProperty(*, country_code=None, protect_status=None)

Bases: object

Specifies the type of protection to use for a country.

For example, to set Canada as allowed, the CountryRule would be formatted as follows:

{ "CountryCode": "CA", "ProtectStatus": "ALLOW" }

Parameters:

country_code (Optional[str]) – The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
protect_status (Optional[str]) – The types of protection that can be used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryrule.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

country_rule_property = smsvoice_mixins.CfnProtectConfigurationPropsMixin.CountryRuleProperty(
    country_code="countryCode",
    protect_status="protectStatus"
)

Attributes

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-properties-smsvoice-protectconfiguration-countryrule.html#cfn-smsvoice-protectconfiguration-countryrule-countrycode

protect_status

The types of protection that can be used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryrule.html#cfn-smsvoice-protectconfiguration-countryrule-protectstatus

CountryRuleSetProperty

class CfnProtectConfigurationPropsMixin.CountryRuleSetProperty(*, mms=None, sms=None, voice=None)

Bases: object

The set of CountryRules you specify to control which countries End User Messaging can send your messages to.

If you don’t specify all available ISO country codes in the CountryRuleSet for each number capability, the CloudFormation drift detection feature will detect drift. This is because End User Messaging always returns all country codes.

Parameters:

mms (Union[IResolvable, Sequence[Union[IResolvable, CountryRuleProperty, Dict[str, Any]]], None]) – The set of CountryRule s to control which destination countries End User Messaging can send your MMS messages to.
sms (Union[IResolvable, Sequence[Union[IResolvable, CountryRuleProperty, Dict[str, Any]]], None]) – The set of CountryRule s to control which destination countries End User Messaging can send your SMS messages to.
voice (Union[IResolvable, Sequence[Union[IResolvable, CountryRuleProperty, Dict[str, Any]]], None]) – The set of CountryRule s to control which destination countries End User Messaging can send your VOICE messages to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryruleset.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

country_rule_set_property = smsvoice_mixins.CfnProtectConfigurationPropsMixin.CountryRuleSetProperty(
    mms=[smsvoice_mixins.CfnProtectConfigurationPropsMixin.CountryRuleProperty(
        country_code="countryCode",
        protect_status="protectStatus"
    )],
    sms=[smsvoice_mixins.CfnProtectConfigurationPropsMixin.CountryRuleProperty(
        country_code="countryCode",
        protect_status="protectStatus"
    )],
    voice=[smsvoice_mixins.CfnProtectConfigurationPropsMixin.CountryRuleProperty(
        country_code="countryCode",
        protect_status="protectStatus"
    )]
)

Attributes

mms

The set of CountryRule s to control which destination countries End User Messaging can send your MMS messages to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryruleset.html#cfn-smsvoice-protectconfiguration-countryruleset-mms

sms

The set of CountryRule s to control which destination countries End User Messaging can send your SMS messages to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryruleset.html#cfn-smsvoice-protectconfiguration-countryruleset-sms

voice

The set of CountryRule s to control which destination countries End User Messaging can send your VOICE messages to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-smsvoice-protectconfiguration-countryruleset.html#cfn-smsvoice-protectconfiguration-countryruleset-voice