CfnBasePathMappingPropsMixin

class aws_cdk.cfn_property_mixins.aws_apigateway.CfnBasePathMappingPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.

Supported only for public custom domain names.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html
CloudformationResource:: AWS::ApiGateway::BasePathMapping
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.cfn_property_mixins import aws_apigateway as apigateway
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_base_path_mapping_props_mixin = apigateway.CfnBasePathMappingPropsMixin(apigateway.CfnBasePathMappingMixinProps(
    base_path="basePath",
    domain_name="domainName",
    id="id",
    rest_api_id="restApiId",
    stage="stage"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::ApiGateway::BasePathMapping.

Parameters:

props (Union[CfnBasePathMappingMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['basePath', 'domainName', 'id', 'restApiId', 'stage']

Static Methods

classmethod is_mixin(x)

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.