Package 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:
WebSocketAwsIntegration, WebSocketLambdaIntegration, WebSocketMockIntegration
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:09:58.135Z") @Stability(Stable) public abstract class WebSocketRouteIntegration extends software.amazon.jsii.JsiiObject
The interface that various route integration classes will inherit.

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

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract 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

    • WebSocketRouteIntegration

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

    • WebSocketRouteIntegration

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

    • WebSocketRouteIntegration

      @Stability(Stable) protected WebSocketRouteIntegration(@NotNull String id)
      Initialize an integration for a route on websocket api.

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

  • Method Details