software.amazon.awscdk.services.apigatewayv2

Interface WebSocketStageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, StageOptions

All Known Implementing Classes:

WebSocketStageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:23.692Z")
 @Stability(value=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

Nested Classes

Modifier and Type	Interface and Description
static class	WebSocketStageProps.Builder A builder for WebSocketStageProps
static class	WebSocketStageProps.Jsii$Proxy An implementation for WebSocketStageProps

Method Summary

Modifier and Type	Method and Description
static WebSocketStageProps.Builder	builder()
String	getStageName() (experimental) The name of the stage.
IWebSocketApi	getWebSocketApi() (experimental) The WebSocket API to which this stage is associated.

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

getAutoDeploy, getDomainMapping, getThrottle

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getStageName

@Stability(value=Experimental)
 @NotNull
String getStageName()

(experimental) The name of the stage.

getWebSocketApi

@Stability(value=Experimental)
 @NotNull
IWebSocketApi getWebSocketApi()

(experimental) The WebSocket API to which this stage is associated.

builder

@Stability(value=Experimental)
static WebSocketStageProps.Builder builder()

Specified by:

builder in interface StageOptions

Returns:

a WebSocketStageProps.Builder of WebSocketStageProps