aws-cdk-lib.aws_apigatewayv2.CfnApiMappingProps

interface CfnApiMappingProps

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.CfnApiMappingProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnApiMappingProps
Javasoftware.amazon.awscdk.services.apigatewayv2.CfnApiMappingProps
Pythonaws_cdk.aws_apigatewayv2.CfnApiMappingProps
TypeScript aws-cdk-lib » aws_apigatewayv2 » CfnApiMappingProps

Properties for defining a CfnApiMapping.

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

NameTypeDescription
apiIdstringThe identifier of the API.
domainNamestringThe domain name.
stagestringThe API stage.
apiMappingKey?stringThe API mapping key.

apiId

Type: string

The identifier of the API.


domainName

Type: string

The domain name.


stage

Type: string

The API stage.


apiMappingKey?

Type: string (optional)

The API mapping key.