Package software.amazon.awscdk.aws_apigatewayv2_integrations

Class WebSocketLambdaIntegration

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.WebSocketRouteIntegration

software.amazon.awscdk.aws_apigatewayv2_integrations.WebSocketLambdaIntegration

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:09.662Z")
@Stability(Stable)
public class WebSocketLambdaIntegration
extends WebSocketRouteIntegration

Lambda WebSocket Integration.

Example:

 import software.amazon.awscdk.aws_apigatewayv2_integrations.WebSocketLambdaIntegration;
 Function messageHandler;
 WebSocketApi webSocketApi = new WebSocketApi(this, "mywsapi");
 WebSocketStage.Builder.create(this, "mystage")
         .webSocketApi(webSocketApi)
         .stageName("dev")
         .autoDeploy(true)
         .build();
 webSocketApi.addRoute("sendMessage", WebSocketRouteOptions.builder()
         .integration(new WebSocketLambdaIntegration("SendMessageIntegration", messageHandler))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WebSocketLambdaIntegration.Builder	A fluent builder for WebSocketLambdaIntegration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
	WebSocketLambdaIntegration(String id, IFunction handler)
	WebSocketLambdaIntegration(String id, IFunction handler, WebSocketLambdaIntegrationProps props)
protected	WebSocketLambdaIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WebSocketLambdaIntegration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
WebSocketRouteIntegrationConfig	bind(WebSocketRouteIntegrationBindOptions options)	Bind this integration to the route.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

WebSocketLambdaIntegration

protected WebSocketLambdaIntegration(software.amazon.jsii.JsiiObjectRef objRef)

WebSocketLambdaIntegration

protected WebSocketLambdaIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

WebSocketLambdaIntegration

@Stability(Stable)
public WebSocketLambdaIntegration(@NotNull
 String id,
 @NotNull
 IFunction handler,
 @Nullable
 WebSocketLambdaIntegrationProps props)

Parameters:

id - id of the underlying integration construct. This parameter is required.

handler - the Lambda function handler. This parameter is required.

props - properties to configure the integration.

WebSocketLambdaIntegration

@Stability(Stable)
public WebSocketLambdaIntegration(@NotNull
 String id,
 @NotNull
 IFunction handler)

Parameters:

id - id of the underlying integration construct. This parameter is required.

handler - the Lambda function handler. This parameter is required.

Method Details

bind

@Stability(Stable)
@NotNull
public WebSocketRouteIntegrationConfig bind(@NotNull
 WebSocketRouteIntegrationBindOptions options)

Bind this integration to the route.

Specified by:

bind in class WebSocketRouteIntegration

Parameters:

options - This parameter is required.