software.amazon.awscdk.services.apigatewayv2

Class WebSocketRouteIntegration

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigatewayv2.WebSocketRouteIntegration

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

WebSocketLambdaIntegration, WebSocketMockIntegration

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:59.886Z")
 @Stability(value=Experimental)
public abstract class WebSocketRouteIntegration
extends software.amazon.jsii.JsiiObject

(experimental) The interface that various route integration classes will inherit.

Example:

 import software.amazon.awscdk.services.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/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebSocketRouteIntegration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WebSocketRouteIntegration(software.amazon.jsii.JsiiObjectRef objRef)
protected	WebSocketRouteIntegration(String id) (experimental) Initialize an integration for a route on websocket api.

Method Summary

Modifier and Type	Method and Description
abstract WebSocketRouteIntegrationConfig	bind(WebSocketRouteIntegrationBindOptions options) (experimental) 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 Detail

WebSocketRouteIntegration

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

WebSocketRouteIntegration

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

WebSocketRouteIntegration

@Stability(value=Experimental)
protected WebSocketRouteIntegration(@NotNull
                                                                   String id)

(experimental) Initialize an integration for a route on websocket api.

Parameters:

id - id of the underlying `WebSocketIntegration` construct. This parameter is required.

Method Detail

bind

@Stability(value=Experimental)
 @NotNull
public abstract WebSocketRouteIntegrationConfig bind(@NotNull
                                                                                              WebSocketRouteIntegrationBindOptions options)

(experimental) Bind this integration to the route.

Parameters:

options - This parameter is required.