# WebSocketStageProps

Properties to initialize an instance of `WebSocketStage`.

Extends: WebSocketStageProps
Extends: StageOptions
Used as props by: WebSocketStage

- Source: [`aws-apigatewayv2/lib/websocket/stage.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-apigatewayv2/lib/websocket/stage.ts#L36)
- Type last changed: v2.112.0 · 1 Dec 2023

## Example

```ts
import * as logs from 'aws-cdk-lib/aws-logs';

declare const httpApi: apigwv2.HttpApi;
declare const webSocketApi : apigwv2.WebSocketApi;
declare const logGroup: logs.LogGroup;

new apigwv2.HttpStage(this, 'HttpStage', {
  httpApi,
  accessLogSettings: {
    destination: new apigwv2.LogGroupLogDestination(logGroup),
  },
});

new apigwv2.WebSocketStage(this, 'WebSocketStage', {
  webSocketApi,
  stageName: 'dev',
  accessLogSettings: {
    destination: new apigwv2.LogGroupLogDestination(logGroup),
  },
});
```

## Properties

- `accessLogSettings`: [IAccessLogSettings](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.IAccessLogSettings.html) — Settings for access logging.

  **Default:** No access logging

- `autoDeploy`: boolean = false — Whether updates to an API automatically trigger a new deployment.

- `description`: string — The description for the API stage.

  **Default:** no description

- `detailedMetricsEnabled`: boolean = false — Specifies whether detailed metrics are enabled.

- `domainMapping`: [DomainMappingOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.DomainMappingOptions.html) — The options for custom domain and api mapping.

  **Default:** no custom domain and api mapping configuration

- `stageName`: string (required) — The name of the stage.

- `stageVariables`: { [key: string]: string } — Stage variables for the stage. These are key-value pairs that you can define and use in your API routes.

  **Default:** No stage variables

  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`: [ThrottleSettings](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.ThrottleSettings.html) — Throttle settings for the routes of this stage.

  **Default:** no throttling configuration

- `webSocketApi`: [IWebSocketApi](/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.IWebSocketApi.html) (required) — The WebSocket API to which this stage is associated.