aws-cdk-lib.aws_apigatewayv2.CfnApiMappingProps

CfnApiMappingProps Struct

Properties for defining a CfnApiMapping.

CfnApiMappingProps

used as props by

• CfnApiMapping

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

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';
const cfnApiMappingProps: apigatewayv2.CfnApiMappingProps = {
  apiId: 'apiId',
  domainName: 'domainName',
  stage: 'stage',

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

Properties

apiIdstring | IRestApiRef | IApiRefapi_idtyping.Union[str, IRestApiRef, IApiRef]apiIdStringApiIdstringApiIdinterface{}required#

The API identifier.

apiMappingKeystringapi_mapping_keystrapiMappingKeyStringApiMappingKeystringApiMappingKey*string#

The API mapping key.

domainNamestring | IDomainNameRef | IDomainNameRefdomain_nametyping.Union[str, IDomainNameRef, IDomainNameRef]domainNameStringDomainNamestringDomainNameinterface{}required#

The domain name.

stagestringstagestrstageStringStagestringStage*stringrequired#

The API stage.