CfnBasePathMappingV2MixinProps

class aws_cdk.mixins_preview.aws_apigateway.mixins.CfnBasePathMappingV2MixinProps(*, base_path=None, domain_name_arn=None, rest_api_id=None, stage=None)

Bases: object

Properties for CfnBasePathMappingV2PropsMixin.

Parameters:

base_path (Optional[str]) – The base path name that callers of the private API must provide as part of the URL after the domain name.
domain_name_arn (Optional[str]) – The ARN of the domain name for the BasePathMappingV2 resource to be described.
rest_api_id (Optional[str]) – The private API’s identifier. This identifier is unique across all of your APIs in API Gateway.
stage (Optional[str]) – Represents a unique identifier for a version of a deployed private RestApi that is callable by users. The Stage must depend on the RestApi ‘s stage. To create a dependency, add a DependsOn attribute to the BasePathMappingV2 resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmappingv2.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_apigateway import mixins as apigateway_mixins

cfn_base_path_mapping_v2_mixin_props = apigateway_mixins.CfnBasePathMappingV2MixinProps(
    base_path="basePath",
    domain_name_arn="domainNameArn",
    rest_api_id="restApiId",
    stage="stage"
)