CfnApiMappingPropsMixin

class aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnApiMappingPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.

An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can’t overlap. A custom domain can map only to APIs of the same protocol type. For more information, see CreateApiMapping in the Amazon API Gateway V2 API Reference .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html
CloudformationResource:: AWS::ApiGatewayV2::ApiMapping
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_apigatewayv2 import mixins as apigatewayv2_mixins

cfn_api_mapping_props_mixin = apigatewayv2_mixins.CfnApiMappingPropsMixin(apigatewayv2_mixins.CfnApiMappingMixinProps(
    api_id="apiId",
    api_mapping_key="apiMappingKey",
    domain_name="domainName",
    stage="stage"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ApiGatewayV2::ApiMapping.

Parameters:

props (Union[CfnApiMappingMixinProps, 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 = ['apiId', 'apiMappingKey', 'domainName', 'stage']

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