Package software.amazon.awscdk.services.apigatewayv2

Interface IWebSocketApi

All Superinterfaces:

IApi, IApiRef, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, IWebSocketApiRef, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IWebSocketApi.Jsii$Default

All Known Implementing Classes:

IWebSocketApi.Jsii$Proxy, WebSocketApi

@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)",
           date="2026-02-09T14:39:02.588Z")
@Stability(Stable)
public interface IWebSocketApi
extends software.amazon.jsii.JsiiSerializable, IApi, IWebSocketApiRef

Represents a WebSocket API.

Nested Class Summary

Nested Classes

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

Method Summary

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

getApiEndpoint, getApiId, metric, metric

Methods inherited from interface software.amazon.awscdk.interfaces.apigatewayv2.IApiRef

getApiRef

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

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

getIsWebsocketApi

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson