Package software.amazon.awscdk.services.apigatewayv2

Interface WebSocketRouteProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, WebSocketRouteOptions

All Known Implementing Classes:

WebSocketRouteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:13.927Z")
@Stability(Stable)
public interface WebSocketRouteProps
extends software.amazon.jsii.JsiiSerializable, WebSocketRouteOptions

Properties to initialize a new Route.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigatewayv2.*;
 WebSocketApi webSocketApi;
 IWebSocketRouteAuthorizer webSocketRouteAuthorizer;
 WebSocketRouteIntegration webSocketRouteIntegration;
 WebSocketRouteProps webSocketRouteProps = WebSocketRouteProps.builder()
         .integration(webSocketRouteIntegration)
         .routeKey("routeKey")
         .webSocketApi(webSocketApi)
         // the properties below are optional
         .apiKeyRequired(false)
         .authorizer(webSocketRouteAuthorizer)
         .returnResponse(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	WebSocketRouteProps.Builder	A builder for WebSocketRouteProps
static final class	WebSocketRouteProps.Jsii$Proxy	An implementation for WebSocketRouteProps

Method Summary

Modifier and Type	Method	Description
static WebSocketRouteProps.Builder	builder()
default Boolean	getApiKeyRequired()	Whether the route requires an API Key to be provided.
String	getRouteKey()	The key to this route.
IWebSocketApi	getWebSocketApi()	The API the route is associated with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.WebSocketRouteOptions

getAuthorizer, getIntegration, getReturnResponse

Method Details

getRouteKey

@Stability(Stable)
@NotNull
String getRouteKey()

The key to this route.

getWebSocketApi

@Stability(Stable)
@NotNull
IWebSocketApi getWebSocketApi()

The API the route is associated with.

getApiKeyRequired

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

Whether the route requires an API Key to be provided.

Default: false

builder

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

Returns:

a WebSocketRouteProps.Builder of WebSocketRouteProps