Package software.amazon.awscdk.services.apigatewayv2

Interface IWebSocketRoute

All Superinterfaces:

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

All Known Subinterfaces:

IWebSocketRoute.Jsii$Default

All Known Implementing Classes:

IWebSocketRoute.Jsii$Proxy, WebSocketRoute

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:43.306Z")
@Stability(Experimental)
public interface IWebSocketRoute
extends software.amazon.jsii.JsiiSerializable, IRoute

(experimental) Represents a Route for an WebSocket API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IWebSocketRoute.Jsii$Default	Internal default implementation for IWebSocketRoute.
static final class	IWebSocketRoute.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
String	getRouteKey()	(experimental) The key to this route.
IWebSocketApi	getWebSocketApi()	(experimental) The WebSocket API associated with this route.

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

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

getRouteId

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRouteKey

@Stability(Experimental)
@NotNull
String getRouteKey()

(experimental) The key to this route.

getWebSocketApi

@Stability(Experimental)
@NotNull
IWebSocketApi getWebSocketApi()

(experimental) The WebSocket API associated with this route.