Package software.amazon.awscdk.services.apigatewayv2.alpha

Interface IWebSocketStage

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IResource, IStage, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IWebSocketStage.Jsii$Default
All Known Implementing Classes:
IWebSocketStage.Jsii$Proxy, WebSocketStage
@Generated(value="jsii-pacmak/1.87.0 (build 9892444)", date="2023-08-23T17:50:59.636Z") @Stability(Experimental) public interface IWebSocketStage extends software.amazon.jsii.JsiiSerializable, IStage
(experimental) Represents the WebSocketStage.

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    IWebSocketApi
    getApi()
    (experimental) The API this stage is associated to.
    String
    getCallbackUrl()
    (experimental) The callback URL to this stage.

    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.awscdk.services.apigatewayv2.alpha.IStage

    getStageName, getUrl, metric, metric

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getApi

      @Stability(Experimental) @NotNull IWebSocketApi getApi()
      (experimental) The API this stage is associated to.

    • getCallbackUrl

      @Stability(Experimental) @NotNull String getCallbackUrl()
      (experimental) The callback URL to this stage.

      You can use the callback URL to send messages to the client from the backend system. https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html