Package software.amazon.awscdk.services.apigatewayv2

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.97.0 (build 729de35)",
           date="2024-04-18T17:54:12.088Z")
@Stability(Stable)
public interface IWebSocketStage
extends software.amazon.jsii.JsiiSerializable, IStage

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()	The API this stage is associated to.
String	getCallbackUrl()	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.IStage

getStageName, getUrl, metric, metric

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApi

@Stability(Stable)
@NotNull
IWebSocketApi getApi()

The API this stage is associated to.

getCallbackUrl

@Stability(Stable)
@NotNull
String getCallbackUrl()

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