@aws-cdk_aws-apigatewayv2-alpha.WebSocketStageProps

interface WebSocketStageProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.WebSocketStageProps
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#WebSocketStageProps
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.WebSocketStageProps
Pythonaws_cdk.aws_apigatewayv2_alpha.WebSocketStageProps
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป WebSocketStageProps

Properties to initialize an instance of WebSocketStage.

Example

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

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

NameTypeDescription
stageName๐Ÿ”นstringThe name of the stage.
webSocketApi๐Ÿ”นIWebSocketApiThe WebSocket API to which this stage is associated.
autoDeploy?๐Ÿ”นbooleanWhether updates to an API automatically trigger a new deployment.
domainMapping?๐Ÿ”นDomainMappingOptionsThe options for custom domain and api mapping.
throttle?๐Ÿ”นThrottleSettingsThrottle 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.