interface BasePathMappingOptions
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGateway.BasePathMappingOptions |
 Java | software.amazon.awscdk.services.apigateway.BasePathMappingOptions |
 Python | aws_cdk.aws_apigateway.BasePathMappingOptions |
 TypeScript (source) | @aws-cdk/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
| Name | Type | Description |
|---|---|---|
| base | string | 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? | Stage | The Deployment stage of API [disable-awslint:ref-via-interface]. |
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].