interface WebSocketStageProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.APIGatewayv2.WebSocketStageProps
Java	software.amazon.awscdk.services.apigatewayv2.WebSocketStageProps
Python	aws_cdk.aws_apigatewayv2.WebSocketStageProps
TypeScript (source)	@aws-cdk/aws-apigatewayv2 » WebSocketStageProps

Properties to initialize an instance of WebSocketStage.

Example

import { WebSocketLambdaIntegration } from '@aws-cdk/aws-apigatewayv2-integrations';

const webSocketApi = new apigwv2.WebSocketApi(this, 'mywsapi');
new apigwv2.WebSocketStage(this, 'mystage', {
  webSocketApi,
  stageName: 'dev',
  autoDeploy: true,
});

declare const messageHandler: lambda.Function;
webSocketApi.addRoute('sendmessage', {
  integration: new WebSocketLambdaIntegration('SendMessageIntegration', messageHandler),
});

Properties

Name	Type	Description
stageName🔹	string	The name of the stage.
webSocketApi🔹	IWebSocketApi	The WebSocket API to which this stage is associated.
autoDeploy?🔹	boolean	Whether updates to an API automatically trigger a new deployment.
domainMapping?🔹	DomainMappingOptions	The options for custom domain and api mapping.
throttle?🔹	ThrottleSettings	Throttle settings for the routes of this stage.

---

stageName🔹

Type: string

The name of the stage.

---

webSocketApi🔹

Type: IWebSocketApi

The WebSocket API to which this stage is associated.

---

autoDeploy?🔹

Type: boolean (optional, default: false)

Whether updates to an API automatically trigger a new deployment.

---

domainMapping?🔹

Type: DomainMappingOptions (optional, default: no custom domain and api mapping configuration)

The options for custom domain and api mapping.

---

throttle?🔹

Type: ThrottleSettings (optional, default: no throttling configuration)

Throttle settings for the routes of this stage.