aws-cdk-lib.aws_apigatewayv2.WebSocketRouteIntegration

WebSocketRouteIntegration Class

The interface that various route integration classes will inherit.

WebSocketRouteIntegration

superclass of

• WebSocketAwsIntegration,
• WebSocketLambdaIntegration,
• 1 more

  • WebSocketMockIntegration

Source

aws-apigatewayv2/lib/websocket/integration.ts

Type last changed

v2.112.0 · 1 Dec 2023

Example

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

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

declare const messageHandler: lambda.Function;
webSocketApi.addRoute('sendMessage', {
  integration: new WebSocketLambdaIntegration('SendMessageIntegration', messageHandler),
});

Initializer

new WebSocketRouteIntegration(id: string)

WebSocketRouteIntegration(id: str)

new WebSocketRouteIntegration(String id)

new WebSocketRouteIntegration(string id)

NewWebSocketRouteIntegration(Id *string)

Methods

bind(options: WebSocketRouteIntegrationBindOptions): WebSocketRouteIntegrationConfigdef bind(self, options: WebSocketRouteIntegrationBindOptions) -> WebSocketRouteIntegrationConfigpublic WebSocketRouteIntegrationConfig bind(WebSocketRouteIntegrationBindOptions options)public WebSocketRouteIntegrationConfig Bind(WebSocketRouteIntegrationBindOptions options)func Bind(Options WebSocketRouteIntegrationBindOptions) WebSocketRouteIntegrationConfig#

Bind this integration to the route.