interface ApiMappingProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Apigatewayv2.ApiMappingProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#ApiMappingProps |
 Java | software.amazon.awscdk.services.apigatewayv2.ApiMappingProps |
 Python | aws_cdk.aws_apigatewayv2.ApiMappingProps |
 TypeScript (source) | aws-cdk-lib » aws_apigatewayv2 » ApiMappingProps |
Properties used to create the ApiMapping resource.
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';
declare const api: apigatewayv2.IApi;
declare const domainName: apigatewayv2.DomainName;
declare const stage: apigatewayv2.IStage;
const apiMappingProps: apigatewayv2.ApiMappingProps = {
api: api,
domainName: domainName,
// the properties below are optional
apiMappingKey: 'apiMappingKey',
stage: stage,
};
Properties
| Name | Type | Description |
|---|---|---|
| api | IApi | The Api to which this mapping is applied. |
| domain | IDomain | custom domain name of the mapping target. |
| api | string | Api mapping key. |
| stage? | IStage | stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API. |
api
Type:
IApi
The Api to which this mapping is applied.
domainName
Type:
IDomain
custom domain name of the mapping target.
apiMappingKey?
Type:
string
(optional, default: undefined for the root path mapping.)
Api mapping key.
The path where this stage should be mapped to on the domain
stage?
Type:
IStage
(optional, default: Default stage of the passed API for HTTP API, required for WebSocket API)
stage for the ApiMapping resource required for WebSocket API defaults to default stage of an HTTP API.