CfnMultiRegionEndpointPropsMixin

class aws_cdk.mixins_preview.aws_ses.mixins.CfnMultiRegionEndpointPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a multi-region endpoint (global-endpoint).

The primary region is going to be the AWS-Region where the operation is executed. The secondary region has to be provided in request’s parameters. From the data flow standpoint there is no difference between primary and secondary regions - sending traffic will be split equally between the two. The primary region is the region where the resource has been created and where it can be managed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-multiregionendpoint.html
CloudformationResource:: AWS::SES::MultiRegionEndpoint
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_ses import mixins as ses_mixins

cfn_multi_region_endpoint_props_mixin = ses_mixins.CfnMultiRegionEndpointPropsMixin(ses_mixins.CfnMultiRegionEndpointMixinProps(
    details=ses_mixins.CfnMultiRegionEndpointPropsMixin.DetailsProperty(
        route_details=[ses_mixins.CfnMultiRegionEndpointPropsMixin.RouteDetailsItemsProperty(
            region="region"
        )]
    ),
    endpoint_name="endpointName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SES::MultiRegionEndpoint.

Parameters:

props (Union[CfnMultiRegionEndpointMixinProps, 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 = ['details', 'endpointName', '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

DetailsProperty

class CfnMultiRegionEndpointPropsMixin.DetailsProperty(*, route_details=None)

Bases: object

An object that contains configuration details of multi-region endpoint (global-endpoint).

Parameters:: route_details (Union[IResolvable, Sequence[Union[IResolvable, RouteDetailsItemsProperty, Dict[str, Any]]], None]) – A list of route configuration details. Must contain exactly one route configuration
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-multiregionendpoint-details.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_ses import mixins as ses_mixins

details_property = ses_mixins.CfnMultiRegionEndpointPropsMixin.DetailsProperty(
    route_details=[ses_mixins.CfnMultiRegionEndpointPropsMixin.RouteDetailsItemsProperty(
        region="region"
    )]
)

Attributes

route_details

A list of route configuration details.

Must contain exactly one route configuration

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-multiregionendpoint-details.html#cfn-ses-multiregionendpoint-details-routedetails

RouteDetailsItemsProperty

class CfnMultiRegionEndpointPropsMixin.RouteDetailsItemsProperty(*, region=None)

Bases: object

Parameters:: region (Optional[str]) – The name of an AWS-Region to be a secondary region for the multi-region endpoint (global-endpoint).
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-multiregionendpoint-routedetailsitems.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_ses import mixins as ses_mixins

route_details_items_property = ses_mixins.CfnMultiRegionEndpointPropsMixin.RouteDetailsItemsProperty(
    region="region"
)

Attributes

region

The name of an AWS-Region to be a secondary region for the multi-region endpoint (global-endpoint).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-multiregionendpoint-routedetailsitems.html#cfn-ses-multiregionendpoint-routedetailsitems-region