Package 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.104.0 (build e79254c)",
           date="2024-11-06T23:25:03.730Z")
@Stability(Stable)
public interface WebSocketStageProps
extends software.amazon.jsii.JsiiSerializable, StageOptions

Properties to initialize an instance of WebSocketStage.

Example:

 import software.amazon.awscdk.aws_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	Description
static final class	WebSocketStageProps.Builder	A builder for WebSocketStageProps
static final class	WebSocketStageProps.Jsii$Proxy	An implementation for WebSocketStageProps

Method Summary

Modifier and Type	Method	Description
static WebSocketStageProps.Builder	builder()
String	getStageName()	The name of the stage.
IWebSocketApi	getWebSocketApi()	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, getDescription, getDomainMapping, getThrottle

Method Details

getStageName

@Stability(Stable)
@NotNull
String getStageName()

The name of the stage.

getWebSocketApi

@Stability(Stable)
@NotNull
IWebSocketApi getWebSocketApi()

The WebSocket API to which this stage is associated.

builder

@Stability(Stable)
static WebSocketStageProps.Builder builder()

Returns:

a WebSocketStageProps.Builder of WebSocketStageProps