Package software.amazon.awscdk.services.apigatewayv2

Interface IWebSocketApiRef

All Superinterfaces:
IApiRef, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IWebSocketApi, IWebSocketApi.Jsii$Default, IWebSocketApiRef.Jsii$Default
All Known Implementing Classes:
IWebSocketApi.Jsii$Proxy, IWebSocketApiRef.Jsii$Proxy, WebSocketApi
@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-03T13:58:15.035Z") @Stability(Stable) public interface IWebSocketApiRef extends software.amazon.jsii.JsiiSerializable, IApiRef
Represents a reference to an HTTP API.

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getIsWebsocketApi()
    Indicates that this is a WebSocket API.

    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.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getIsWebsocketApi

      @Stability(Stable) @NotNull Boolean getIsWebsocketApi()
      Indicates that this is a WebSocket API.

      Will always return true, but is necessary to prevent accidental structural equality in TypeScript.