@aws-cdk_aws-apigatewayv2-alpha.WebSocketStageProps
interface WebSocketStageProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Apigatewayv2.Alpha.WebSocketStageProps |
![]() | github.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#WebSocketStageProps |
![]() | software.amazon.awscdk.services.apigatewayv2.alpha.WebSocketStageProps |
![]() | aws_cdk.aws_apigatewayv2_alpha.WebSocketStageProps |
![]() | @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
Name | Type | Description |
---|---|---|
stage | string | The name of the stage. |
web | IWeb | The WebSocket API to which this stage is associated. |
auto | boolean | Whether updates to an API automatically trigger a new deployment. |
domain | Domain | The options for custom domain and api mapping. |
throttle? | Throttle | Throttle settings for the routes of this stage. |
stageName
Type:
string
The name of the stage.
webSocketApi
Type:
IWeb
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:
Domain
(optional, default: no custom domain and api mapping configuration)
The options for custom domain and api mapping.
throttle?
Type:
Throttle
(optional, default: no throttling configuration)
Throttle settings for the routes of this stage.