interface WebSocketStageProps

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.WebSocketStageProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#WebSocketStageProps
Java	software.amazon.awscdk.services.apigatewayv2.WebSocketStageProps
Python	aws_cdk.aws_apigatewayv2.WebSocketStageProps
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » WebSocketStageProps

Properties to initialize an instance of WebSocketStage.

Example

import { WebSocketLambdaIntegration } from 'aws-cdk-lib/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.
accessLogSettings?	IAccessLogSettings	Settings for access logging.
autoDeploy?	boolean	Whether updates to an API automatically trigger a new deployment.
description?	string	The description for the API stage.
detailedMetricsEnabled?	boolean	Specifies whether detailed metrics are enabled.
domainMapping?	DomainMappingOptions	The options for custom domain and api mapping.
stageVariables?	{ [string]: string }	Stage variables for the stage. These are key-value pairs that you can define and use in your API routes.
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.

---

accessLogSettings?

Type: IAccessLogSettings (optional, default: No access logging)

Settings for access logging.

---

autoDeploy?

Type: boolean (optional, default: false)

Whether updates to an API automatically trigger a new deployment.

---

description?

Type: string (optional, default: no description)

The description for the API stage.

---

detailedMetricsEnabled?

Type: boolean (optional, default: false)

Specifies whether detailed metrics are enabled.

---

domainMapping?

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

The options for custom domain and api mapping.

---

stageVariables?

Type: { [string]: string } (optional, default: No stage variables)

Stage variables for the stage. These are key-value pairs that you can define and use in your API routes.

The allowed characters for variable names and the required pattern for variable values are specified here: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables

---

throttle?

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

Throttle settings for the routes of this stage.