class CfnApiPropsMixin

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

Implements IMixin

Extends Mixin

The AWS::ApiGatewayV2::Api resource creates an API.

WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway in the API Gateway Developer Guide . For more information about HTTP APIs, see HTTP APIs in the API Gateway Developer Guide.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.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';

declare const body: any;
const cfnApiPropsMixin = new apigatewayv2_mixins.CfnApiPropsMixin({
  apiKeySelectionExpression: 'apiKeySelectionExpression',
  basePath: 'basePath',
  body: body,
  bodyS3Location: {
    bucket: 'bucket',
    etag: 'etag',
    key: 'key',
    version: 'version',
  },
  corsConfiguration: {
    allowCredentials: false,
    allowHeaders: ['allowHeaders'],
    allowMethods: ['allowMethods'],
    allowOrigins: ['allowOrigins'],
    exposeHeaders: ['exposeHeaders'],
    maxAge: 123,
  },
  credentialsArn: 'credentialsArn',
  description: 'description',
  disableExecuteApiEndpoint: false,
  disableSchemaValidation: false,
  failOnWarnings: false,
  ipAddressType: 'ipAddressType',
  name: 'name',
  protocolType: 'protocolType',
  routeKey: 'routeKey',
  routeSelectionExpression: 'routeSelectionExpression',
  tags: {
    tagsKey: 'tags',
  },
  target: 'target',
  version: 'version',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnApiPropsMixin(props: CfnApiMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

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

---

props

Type: CfnApiMixinProps

---

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.