Class WebSocketStageProps
(experimental) Properties to initialize an instance of WebSocketStage
.
Inheritance
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class WebSocketStageProps : Object, IWebSocketStageProps, IStageOptions
Syntax (vb)
Public Class WebSocketStageProps
Inherits Object
Implements IWebSocketStageProps, IStageOptions
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.APIGatewayv2.Integrations;
Function messageHandler;
var webSocketApi = new WebSocketApi(this, "mywsapi");
new WebSocketStage(this, "mystage", new WebSocketStageProps {
WebSocketApi = webSocketApi,
StageName = "dev",
AutoDeploy = true
});
webSocketApi.AddRoute("sendmessage", new WebSocketRouteOptions {
Integration = new WebSocketLambdaIntegration("SendMessageIntegration", messageHandler)
});
Synopsis
Constructors
WebSocketStageProps() |
Properties
AutoDeploy | (experimental) Whether updates to an API automatically trigger a new deployment. |
DomainMapping | (experimental) The options for custom domain and api mapping. |
StageName | (experimental) The name of the stage. |
Throttle | (experimental) Throttle settings for the routes of this stage. |
WebSocketApi | (experimental) The WebSocket API to which this stage is associated. |
Constructors
WebSocketStageProps()
public WebSocketStageProps()
Properties
AutoDeploy
(experimental) Whether updates to an API automatically trigger a new deployment.
public Nullable<bool> AutoDeploy { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Stability: Experimental
DomainMapping
(experimental) The options for custom domain and api mapping.
public IDomainMappingOptions DomainMapping { get; set; }
Property Value
Remarks
Default: - no custom domain and api mapping configuration
Stability: Experimental
StageName
(experimental) The name of the stage.
public string StageName { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
Throttle
(experimental) Throttle settings for the routes of this stage.
public IThrottleSettings Throttle { get; set; }
Property Value
Remarks
Default: - no throttling configuration
Stability: Experimental
WebSocketApi
(experimental) The WebSocket API to which this stage is associated.
public IWebSocketApi WebSocketApi { get; set; }
Property Value
Remarks
Stability: Experimental