Class WebSocketStageProps

Properties to initialize an instance of WebSocketStage.

Inheritance

object

WebSocketStageProps

Implements

IWebSocketStageProps

IStageOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class WebSocketStageProps : IWebSocketStageProps, IStageOptions

Syntax (vb)

Public Class WebSocketStageProps Implements IWebSocketStageProps, IStageOptions

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Logs;

            HttpApi httpApi;
            WebSocketApi webSocketApi;
            LogGroup logGroup;


            new HttpStage(this, "HttpStage", new HttpStageProps {
                HttpApi = httpApi,
                AccessLogSettings = new Dictionary<string, IAccessLogDestination> {
                    { "destination", new LogGroupLogDestination(logGroup) }
                }
            });

            new WebSocketStage(this, "WebSocketStage", new WebSocketStageProps {
                WebSocketApi = webSocketApi,
                StageName = "dev",
                AccessLogSettings = new Dictionary<string, IAccessLogDestination> {
                    { "destination", new LogGroupLogDestination(logGroup) }
                }
            });

Synopsis

Constructors

WebSocketStageProps()

Properties to initialize an instance of WebSocketStage.

Properties

AccessLogSettings	Settings for access logging.
AutoDeploy	Whether updates to an API automatically trigger a new deployment.
Description	The description for the API stage.
DetailedMetricsEnabled	Specifies whether detailed metrics are enabled.
DomainMapping	The options for custom domain and api mapping.
StageName	The name of the stage.
StageVariables	Stage variables for the stage. These are key-value pairs that you can define and use in your API routes.
Throttle	Throttle settings for the routes of this stage.
WebSocketApi	The WebSocket API to which this stage is associated.

Constructors

WebSocketStageProps()

Properties to initialize an instance of WebSocketStage.

public WebSocketStageProps()

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Logs;

            HttpApi httpApi;
            WebSocketApi webSocketApi;
            LogGroup logGroup;


            new HttpStage(this, "HttpStage", new HttpStageProps {
                HttpApi = httpApi,
                AccessLogSettings = new Dictionary<string, IAccessLogDestination> {
                    { "destination", new LogGroupLogDestination(logGroup) }
                }
            });

            new WebSocketStage(this, "WebSocketStage", new WebSocketStageProps {
                WebSocketApi = webSocketApi,
                StageName = "dev",
                AccessLogSettings = new Dictionary<string, IAccessLogDestination> {
                    { "destination", new LogGroupLogDestination(logGroup) }
                }
            });

Properties

AccessLogSettings

Settings for access logging.

public IAccessLogSettings? AccessLogSettings { get; set; }

Property Value

IAccessLogSettings

Remarks

Default: - No access logging

AutoDeploy

Whether updates to an API automatically trigger a new deployment.

public bool? AutoDeploy { get; set; }

Property Value

bool?

Remarks

Default: false

Description

The description for the API stage.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - no description

DetailedMetricsEnabled

Specifies whether detailed metrics are enabled.

public bool? DetailedMetricsEnabled { get; set; }

Property Value

bool?

Remarks

Default: false

DomainMapping

The options for custom domain and api mapping.

public IDomainMappingOptions? DomainMapping { get; set; }

Property Value

IDomainMappingOptions

Remarks

Default: - no custom domain and api mapping configuration

StageName

The name of the stage.

public string StageName { get; set; }

Property Value

string

Remarks

ExampleMetadata: infused

StageVariables

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

public IDictionary<string, string>? StageVariables { get; set; }

Property Value

IDictionary<string, string>

Remarks

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

Default: - No stage variables

Throttle

Throttle settings for the routes of this stage.

public IThrottleSettings? Throttle { get; set; }

Property Value

IThrottleSettings

Remarks

Default: - no throttling configuration

WebSocketApi

The WebSocket API to which this stage is associated.

public IWebSocketApi WebSocketApi { get; set; }

Property Value

IWebSocketApi

Remarks

ExampleMetadata: infused

Implements

IWebSocketStageProps

IStageOptions