Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketRoute

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigatewayv2.WebSocketRoute

All Implemented Interfaces:

IResource, IRoute, IWebSocketRoute, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:31.779Z")
@Stability(Stable)
public class WebSocketRoute
extends Resource
implements IWebSocketRoute

Route class that creates the Route for API Gateway WebSocket API.

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;
 WebSocketRoute webSocketRoute = WebSocketRoute.Builder.create(this, "MyWebSocketRoute")
         .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	Class	Description
static final class	WebSocketRoute.Builder	A fluent builder for WebSocketRoute.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IWebSocketRoute

IWebSocketRoute.Jsii$Default, IWebSocketRoute.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebSocketRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WebSocketRoute(software.amazon.jsii.JsiiObjectRef objRef)
	WebSocketRoute(software.constructs.Construct scope, String id, WebSocketRouteProps props)

Method Summary

Modifier and Type	Method	Description
String	getIntegrationResponseId()	Integration response ID.
String	getRouteId()	Id of the Route.
String	getRouteKey()	The key to this route.
IWebSocketApi	getWebSocketApi()	The WebSocket API associated with this route.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

WebSocketRoute

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

WebSocketRoute

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

WebSocketRoute

@Stability(Stable)
public WebSocketRoute(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 WebSocketRouteProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

getRouteId

@Stability(Stable)
@NotNull
public String getRouteId()

Id of the Route.

Specified by:

getRouteId in interface IRoute

getRouteKey

@Stability(Stable)
@NotNull
public String getRouteKey()

The key to this route.

Specified by:

getRouteKey in interface IWebSocketRoute

getWebSocketApi

@Stability(Stable)
@NotNull
public IWebSocketApi getWebSocketApi()

The WebSocket API associated with this route.

Specified by:

getWebSocketApi in interface IWebSocketRoute

getIntegrationResponseId

@Stability(Stable)
@Nullable
public String getIntegrationResponseId()

Integration response ID.