L1 Construct
AWS::ApiGateway::BasePathMappingCfnBasePathMapping
The `AWS::ApiGateway::BasePathMapping` resource creates a base path that clients who call your API must use in the invocation URL. Supported only for public custom domain names.
Import
import { CfnBasePathMapping } from 'aws-cdk-lib/aws-apigateway';Or use the module namespace:
import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.CfnBasePathMappingProperties
Configuration passed to the constructor as CfnBasePathMappingProps.
domainNameRequiredstring | IDomainNameRefThe domain name of the BasePathMapping resource to be described.
basePathOptionalstringThe base path name that callers of the API must provide as part of the URL after the domain name.
idOptionalstringrestApiIdOptionalstring | IRestApiRefThe string identifier of the associated RestApi.
stageOptionalstring | IStageRefThe name of the associated stage.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Get the Amazon API Gateway Cheat Sheet
Everything you need to know about Amazon API Gateway on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
LevelL1 (CloudFormation)
Module
aws-apigatewayCFN Type
AWS::ApiGateway::BasePathMappingProperties5