CfnBasePathMappingMixinProps

class aws_cdk.mixins_preview.aws_apigateway.mixins.CfnBasePathMappingMixinProps(*, base_path=None, domain_name=None, id=None, rest_api_id=None, stage=None)

Bases: object

Properties for CfnBasePathMappingPropsMixin.

Parameters:
  • base_path (Optional[str]) – The base path name that callers of the API must provide as part of the URL after the domain name.

  • domain_name (Optional[str]) – The domain name of the BasePathMapping resource to be described.

  • id (Optional[str])

  • rest_api_id (Optional[str]) – The string identifier of the associated RestApi.

  • stage (Optional[str]) – The name of the associated stage.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.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_mixin_props = apigateway_mixins.CfnBasePathMappingMixinProps(
    base_path="basePath",
    domain_name="domainName",
    id="id",
    rest_api_id="restApiId",
    stage="stage"
)

Attributes

base_path

The base path name that callers of the API must provide as part of the URL after the domain name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath

domain_name

The domain name of the BasePathMapping resource to be described.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname

id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-id

Type:

see

rest_api_id

The string identifier of the associated RestApi.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid

stage

The name of the associated stage.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage