interface BasePathMappingProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.BasePathMappingProps
Java	software.amazon.awscdk.services.apigateway.BasePathMappingProps
Python	aws_cdk.aws_apigateway.BasePathMappingProps
TypeScript (source)	@aws-cdk/aws-apigateway » BasePathMappingProps

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigateway from '@aws-cdk/aws-apigateway';

declare const domainName: apigateway.DomainName;
declare const restApi: apigateway.RestApi;
declare const stage: apigateway.Stage;
const basePathMappingProps: apigateway.BasePathMappingProps = {
  domainName: domainName,
  restApi: restApi,

  // the properties below are optional
  basePath: 'basePath',
  stage: stage,
};

Properties

Name	Type	Description
domainName	IDomainName	The DomainName to associate with this base path mapping.
restApi	IRestApi	The RestApi resource to target.
basePath?	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].

---

domainName

Type: IDomainName

The DomainName to associate with this base path mapping.

---

restApi

Type: IRestApi

The RestApi resource to target.

---

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].