interface CfnBasePathMappingProps

Language	Type name
.NET	`Amazon.CDK.AWS.APIGateway.CfnBasePathMappingProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnBasePathMappingProps`
Java	`software.amazon.awscdk.services.apigateway.CfnBasePathMappingProps`
Python	`aws_cdk.aws_apigateway.CfnBasePathMappingProps`
TypeScript	`aws-cdk-lib` » `aws_apigateway` » `CfnBasePathMappingProps`

Properties for defining a CfnBasePathMapping.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
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 \|` `IDomainNameRef`	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`
restApiId?	`string \|` `IRestApiRef`	The string identifier of the associated RestApi.
stage?	`string \|` `IStageRef`	The name of the associated stage.