class CfnApiMappingPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins.CfnApiMappingPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigatewayv2/mixins#CfnApiMappingPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins.CfnApiMappingPropsMixin
Python	aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnApiMappingPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_apigatewayv2 » mixins » CfnApiMappingPropsMixin

Implements IMixin

Extends Mixin

The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.

An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can't overlap. A custom domain can map only to APIs of the same protocol type. For more information, see CreateApiMapping in the Amazon API Gateway V2 API Reference .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as apigatewayv2_mixins } from '@aws-cdk/mixins-preview/aws-apigatewayv2';
const cfnApiMappingPropsMixin = new apigatewayv2_mixins.CfnApiMappingPropsMixin({
  apiId: 'apiId',
  apiMappingKey: 'apiMappingKey',
  domainName: 'domainName',
  stage: 'stage',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnApiMappingPropsMixin(props: CfnApiMappingMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnApiMappingMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::ApiGatewayV2::ApiMapping.

Properties

Name	Type	Description
props	CfnApiMappingMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnApiMappingMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.