BasePathMappingProps

class aws_cdk.aws_apigateway.BasePathMappingProps(*, base_path=None, stage=None, domain_name, rest_api)

Bases: aws_cdk.aws_apigateway.BasePathMappingOptions

Parameters

  • base_path (Optional[str]) – The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can’t be an empty string. Default: - map requests from the domain root (e.g. example.com). If this is undefined, no additional mappings will be allowed on this domain name.

  • stage (Optional[Stage]) – The Deployment stage of API [disable-awslint:ref-via-interface]. Default: - map to deploymentStage of restApi otherwise stage needs to pass in URL

  • domain_name (IDomainName) – The DomainName to associate with this base path mapping.

  • rest_api (IRestApi) – The RestApi resource to target.

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

# domain_name: apigateway.DomainName
# rest_api: apigateway.RestApi
# stage: apigateway.Stage

base_path_mapping_props = apigateway.BasePathMappingProps(
    domain_name=domain_name,
    rest_api=rest_api,

    # the properties below are optional
    base_path="basePath",
    stage=stage
)

Attributes

base_path

The base path name that callers of the API must provide in the URL after the domain name (e.g. example.com/base-path). If you specify this property, it can’t be an empty string.

Default

  • map requests from the domain root (e.g. example.com). If this

is undefined, no additional mappings will be allowed on this domain name.

Return type

Optional[str]

domain_name

The DomainName to associate with this base path mapping.

Return type

IDomainName

rest_api

The RestApi resource to target.

Return type

IRestApi

stage

ref-via-interface].

Default

  • map to deploymentStage of restApi otherwise stage needs to pass in URL

Type

The Deployment stage of API [disable-awslint

Return type

Optional[Stage]