software.amazon.awscdk.services.apigatewayv2

Interface IWebSocketStage

All Superinterfaces:

IConstruct, IDependable, IResource, IStage

All Known Subinterfaces:

IWebSocketStage.Jsii$Default

All Known Implementing Classes:

IWebSocketStage.Jsii$Proxy, WebSocketStage

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.269Z")
public interface IWebSocketStage
extends IStage

(experimental) Represents the WebSocketStage.

Nested Class Summary

Nested Classes

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

Method Summary

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

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

getStageName, getUrl, metric, metric

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

applyRemovalPolicy, getEnv, getStack

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

getNode

Method Detail

getApi

IWebSocketApi getApi()

(experimental) The API this stage is associated to.

getCallbackUrl

java.lang.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