Package software.amazon.awscdk.services.apigatewayv2

Interface WebSocketRouteOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

WebSocketRouteProps

All Known Implementing Classes:

WebSocketRouteOptions.Jsii$Proxy, WebSocketRouteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:31.794Z")
@Stability(Stable)
public interface WebSocketRouteOptions
extends software.amazon.jsii.JsiiSerializable

Options used to add route to the API.

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	Interface	Description
static final class	WebSocketRouteOptions.Builder	A builder for WebSocketRouteOptions
static final class	WebSocketRouteOptions.Jsii$Proxy	An implementation for WebSocketRouteOptions

Method Summary

Modifier and Type	Method	Description
static WebSocketRouteOptions.Builder	builder()
default IWebSocketRouteAuthorizer	getAuthorizer()	The authorize to this route.
WebSocketRouteIntegration	getIntegration()	The integration to be configured on this route.
default Boolean	getReturnResponse()	Should the route send a response to the client.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIntegration

@Stability(Stable)
@NotNull
WebSocketRouteIntegration getIntegration()

The integration to be configured on this route.

getAuthorizer

@Stability(Stable)
@Nullable
default IWebSocketRouteAuthorizer getAuthorizer()

The authorize to this route.

You can only set authorizer to a $connect route.

Default: - No Authorizer

getReturnResponse

@Stability(Stable)
@Nullable
default Boolean getReturnResponse()

Should the route send a response to the client.

Default: false

builder

@Stability(Stable)
static WebSocketRouteOptions.Builder builder()

Returns:

a WebSocketRouteOptions.Builder of WebSocketRouteOptions