AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::ApiGateway::BasePathMappingV2

CfnBasePathMappingV2

The `AWS::ApiGateway::BasePathMappingV2` resource creates a base path that clients who call your API must use in the invocation URL. Supported only for private custom domain names.

Import

import { CfnBasePathMappingV2 } from 'aws-cdk-lib/aws-apigateway';

Or use the module namespace:

import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.CfnBasePathMappingV2

Properties

Configuration passed to the constructor as CfnBasePathMappingV2Props.

domainNameArnRequired
string

The ARN of the domain name for the BasePathMappingV2 resource to be described.

restApiIdRequired
string

The private API's identifier. This identifier is unique across all of your APIs in API Gateway.

basePathOptional
string

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

stageOptional
string

Represents a unique identifier for a version of a deployed private RestApi that is callable by users. The Stage must depend on the `RestApi` 's stage. To create a dependency, add a DependsOn attribute to the BasePathMappingV2 resource.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::ApiGateway::BasePathMappingV2View in CloudFormation Explorer

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 Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-apigateway
CFN TypeAWS::ApiGateway::BasePathMappingV2
Properties4

Related Constructs

Explore This Service

External Links