Interface WebSocketStageProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,StageOptions
- All Known Implementing Classes:
WebSocketStageProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:43.361Z")
@Stability(Experimental)
public interface WebSocketStageProps
extends software.amazon.jsii.JsiiSerializable, StageOptions
(experimental) Properties to initialize an instance of
WebSocketStage
.
Example:
import software.amazon.awscdk.services.apigatewayv2.integrations.WebSocketLambdaIntegration; Function messageHandler; WebSocketApi webSocketApi = new WebSocketApi(this, "mywsapi"); WebSocketStage.Builder.create(this, "mystage") .webSocketApi(webSocketApi) .stageName("dev") .autoDeploy(true) .build(); webSocketApi.addRoute("sendmessage", WebSocketRouteOptions.builder() .integration(new WebSocketLambdaIntegration("SendMessageIntegration", messageHandler)) .build());
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forWebSocketStageProps
static final class
An implementation forWebSocketStageProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic WebSocketStageProps.Builder
builder()
(experimental) The name of the stage.(experimental) The WebSocket API to which this stage is associated.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.StageOptions
getAutoDeploy, getDomainMapping, getThrottle
-
Method Details
-
getStageName
(experimental) The name of the stage. -
getWebSocketApi
(experimental) The WebSocket API to which this stage is associated. -
builder
- Returns:
- a
WebSocketStageProps.Builder
ofWebSocketStageProps
-