@aws-cdk_aws-apigatewayv2-alpha.ApiMappingProps

interface ApiMappingProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.ApiMappingProps
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#ApiMappingProps
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.ApiMappingProps
Pythonaws_cdk.aws_apigatewayv2_alpha.ApiMappingProps
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป 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 * as apigatewayv2_alpha from '@aws-cdk/aws-apigatewayv2-alpha';

declare const api: apigatewayv2_alpha.IApi;
declare const domainName: apigatewayv2_alpha.DomainName;
declare const stage: apigatewayv2_alpha.IStage;
const apiMappingProps: apigatewayv2_alpha.ApiMappingProps = {
  api: api,
  domainName: domainName,

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

Properties

NameTypeDescription
api๐Ÿ”นIApiThe Api to which this mapping is applied.
domainName๐Ÿ”นIDomainNamecustom domain name of the mapping target.
apiMappingKey?๐Ÿ”นstringApi mapping key.
stage?๐Ÿ”นIStagestage 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: IDomainName

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.