aws-cdk-lib.aws_apigateway.CfnBasePathMappingProps

interface CfnBasePathMappingProps

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnBasePathMappingProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnBasePathMappingProps
Javasoftware.amazon.awscdk.services.apigateway.CfnBasePathMappingProps
Pythonaws_cdk.aws_apigateway.CfnBasePathMappingProps
TypeScript aws-cdk-lib » 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 { 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

NameTypeDescription
domainNamestringThe domain name of the BasePathMapping resource to be described.
basePath?stringThe base path name that callers of the API must provide as part of the URL after the domain name.
id?stringAWS::ApiGateway::BasePathMapping.Id.
restApiId?stringThe string identifier of the associated RestApi.
stage?stringThe 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.