interface CfnBasePathMappingProps

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

Properties for defining a CfnBasePathMapping.

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';
const cfnBasePathMappingProps: apigateway.CfnBasePathMappingProps = {
  domainName: 'domainName',

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

Properties

Name	Type	Description
domainName	string	The domain name of the BasePathMapping resource to be described.
basePath?	string	The base path name that callers of the API must provide as part of the URL after the domain name.
id?	string	AWS::ApiGateway::BasePathMapping.Id.
restApiId?	string	The string identifier of the associated RestApi.
stage?	string	The name of the associated stage.

---

domainName

Type: string

The domain name of the BasePathMapping resource to be described.

---

basePath?

Type: string (optional)

The base path name that callers of the API must provide as part of the URL after the domain name.

---

id?

Type: string (optional)

AWS::ApiGateway::BasePathMapping.Id.

---

restApiId?

Type: string (optional)

The string identifier of the associated RestApi.

---

stage?

Type: string (optional)

The name of the associated stage.