class CfnRouteResponsePropsMixin

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

Implements IMixin

Extends Mixin

The AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API.

For more information, see Set up Route Responses for a WebSocket API in API Gateway in the API Gateway Developer Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.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 responseModels: any;
const cfnRouteResponsePropsMixin = new apigatewayv2_mixins.CfnRouteResponsePropsMixin({
  apiId: 'apiId',
  modelSelectionExpression: 'modelSelectionExpression',
  responseModels: responseModels,
  responseParameters: {
    responseParametersKey: {
      required: false,
    },
  },
  routeId: 'routeId',
  routeResponseKey: 'routeResponseKey',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnRouteResponsePropsMixin(props: CfnRouteResponseMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

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

---

props

Type: CfnRouteResponseMixinProps

---

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.