interface CfnApiMappingProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGatewayv2.CfnApiMappingProps |
 Java | software.amazon.awscdk.services.apigatewayv2.CfnApiMappingProps |
 Python | aws_cdk.aws_apigatewayv2.CfnApiMappingProps |
 TypeScript | @aws-cdk/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 * as apigatewayv2 from '@aws-cdk/aws-apigatewayv2';
const cfnApiMappingProps: apigatewayv2.CfnApiMappingProps = {
apiId: 'apiId',
domainName: 'domainName',
stage: 'stage',
// the properties below are optional
apiMappingKey: 'apiMappingKey',
};
Properties
| Name | Type | Description |
|---|---|---|
| api | string | The identifier of the API. |
| domain | string | The domain name. |
| stage | string | The API stage. |
| api | string | The 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.