aws-cdk-lib.aws_apigateway.BasePathMappingOptions

BasePathMappingOptions Struct

Source

aws-apigateway/lib/base-path-mapping.ts

Type last changed

v2.45.0 · 6 Oct 2022

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

attachToStagebooleanattach_to_stageboolattachToStageBooleanAttachToStageboolAttachToStage*bool= 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.

basePathstringbase_pathstrbasePathStringBasePathstringBasePath*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.

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.

stageStagestageStagestageStageStageStageStageStage#

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

Default: map to deploymentStage of restApi otherwise stage needs to pass in URL