class CfnBasePathMappingV2PropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.ApiGateway.CfnBasePathMappingV2PropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsapigateway#CfnBasePathMappingV2PropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.apigateway.CfnBasePathMappingV2PropsMixin
Python	aws_cdk.cfn_property_mixins.aws_apigateway.CfnBasePathMappingV2PropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_apigateway » CfnBasePathMappingV2PropsMixin

Implements IMixin

Extends Mixin

The AWS::ApiGateway::BasePathMappingV2 resource creates a base path that clients who call your API must use in the invocation URL.

Supported only for private custom domain names.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnBasePathMappingV2PropsMixin = new apigateway.CfnBasePathMappingV2PropsMixin({
  basePath: 'basePath',
  domainNameArn: 'domainNameArn',
  restApiId: 'restApiId',
  stage: 'stage',
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnBasePathMappingV2PropsMixin(props: CfnBasePathMappingV2MixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::ApiGateway::BasePathMappingV2.

Properties

Name	Type	Description
props	CfnBasePathMappingV2MixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnBasePathMappingV2MixinProps

---

strategy

Type: IMergeStrategy

---

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): void

Parameters

• construct 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.