aws-cdk-lib.aws_apigateway.BasePathMappingOptions

interface BasePathMappingOptions

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.BasePathMappingOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#BasePathMappingOptions
Javasoftware.amazon.awscdk.services.apigateway.BasePathMappingOptions
Pythonaws_cdk.aws_apigateway.BasePathMappingOptions
TypeScript (source)aws-cdk-lib » aws_apigateway » BasePathMappingOptions

Example

declare const domain: apigateway.DomainName;
declare const api1: apigateway.RestApi;
declare const api2: apigateway.RestApi;

domain.addBasePathMapping(api1, { basePath: 'go-to-api1' });
domain.addBasePathMapping(api2, { basePath: 'boom' });

Properties

NameTypeDescription
attachToStage?booleanWhether to attach the base path mapping to a stage.
basePath?stringThe 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.
stage?StageThe Deployment stage of API [disable-awslint:ref-via-interface].

attachToStage?

Type: boolean (optional, default: true)

Whether to attach the base path mapping to a stage.

Use this property to create a base path mapping without attaching it to the Rest API default stage. This property is ignored if stage is provided.


basePath?

Type: string (optional, 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.)

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.


stage?

Type: Stage (optional, default: map to deploymentStage of restApi otherwise stage needs to pass in URL)

The Deployment stage of API [disable-awslint:ref-via-interface].