class WebSocketMockIntegration

Language	Type name
.NET	`Amazon.CDK.AwsApigatewayv2Integrations.WebSocketMockIntegration`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2integrations#WebSocketMockIntegration`
Java	`software.amazon.awscdk.aws_apigatewayv2_integrations.WebSocketMockIntegration`
Python	`aws_cdk.aws_apigatewayv2_integrations.WebSocketMockIntegration`
TypeScript (source)	`aws-cdk-lib` » `aws_apigatewayv2_integrations` » `WebSocketMockIntegration`

Extends WebSocketRouteIntegration

Mock WebSocket Integration.

Example

import { WebSocketMockIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';

const webSocketApi = new apigwv2.WebSocketApi(this, 'mywsapi');
new apigwv2.WebSocketStage(this, 'mystage', {
  webSocketApi,
  stageName: 'dev',
  autoDeploy: true,
});

webSocketApi.addRoute('sendMessage', {
  integration: new WebSocketMockIntegration('DefaultIntegration', {
    requestTemplates: { 'application/json': JSON.stringify({ statusCode: 200 }) },
    templateSelectionExpression: '\\$default',
  }),
  returnResponse: true,
});

Initializer

new WebSocketMockIntegration(id: string, props?: WebSocketMockIntegrationProps)

Parameters

id string — id of the underlying integration construct.
props WebSocketMockIntegrationProps

Methods

Name	Description
bind(options)	Bind this integration to the route.

bind(options)

public bind(options: WebSocketRouteIntegrationBindOptions): WebSocketRouteIntegrationConfig

Parameters

options WebSocketRouteIntegrationBindOptions

Returns

WebSocketRouteIntegrationConfig

Bind this integration to the route.