aws-cdk-lib.aws_apigatewayv2.ApiMappingProps

ApiMappingProps Struct

Properties used to create the ApiMapping resource.

ApiMappingProps

used as props by

• ApiMapping

Source

aws-apigatewayv2/lib/common/api-mapping.ts

Type last changed

v2.235.0 · 15 Jan 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
import { aws_apigatewayv2 as interfaces_apigatewayv2 } from 'aws-cdk-lib/interfaces';

declare const apiRef: interfaces_apigatewayv2.IApiRef;
declare const domainNameRef: interfaces_apigatewayv2.IDomainNameRef;
declare const stage: apigatewayv2.IStage;
const apiMappingProps: apigatewayv2.ApiMappingProps = {
  api: apiRef,
  domainName: domainNameRef,

  // the properties below are optional
  apiMappingKey: 'apiMappingKey',
  stage: stage,
};

Properties

apiIApiRefapiIApiRefapiIApiRefApiIApiRefApiIApiRefrequired#

The Api to which this mapping is applied.

apiMappingKeystringapi_mapping_keystrapiMappingKeyStringApiMappingKeystringApiMappingKey*string= undefined for the root path mapp…#

Api mapping key.

The path where this stage should be mapped to on the domain

default

Default: undefined for the root path mapping.

domainNameIDomainNameRefdomain_nameIDomainNameRefdomainNameIDomainNameRefDomainNameIDomainNameRefDomainNameIDomainNameRefrequired#

custom domain name of the mapping target.

stageIStagestageIStagestageIStageStageIStageStageIStage= Default stage of the passed API …#

stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.

default

Default: Default stage of the passed API for HTTP API, required for WebSocket API