WebSocketStageProps

class aws_cdk.aws_apigatewayv2.WebSocketStageProps(*, access_log_settings=None, auto_deploy=None, description=None, detailed_metrics_enabled=None, domain_mapping=None, stage_variables=None, throttle=None, stage_name, web_socket_api)

Bases: StageOptions

Properties to initialize an instance of WebSocketStage.

Parameters:

  • access_log_settings (Optional[IAccessLogSettings]) – Settings for access logging. Default: - No access logging

  • auto_deploy (Optional[bool]) – Whether updates to an API automatically trigger a new deployment. Default: false

  • description (Optional[str]) – The description for the API stage. Default: - no description

  • detailed_metrics_enabled (Optional[bool]) – Specifies whether detailed metrics are enabled. Default: false

  • domain_mapping (Union[DomainMappingOptions, Dict[str, Any], None]) – The options for custom domain and api mapping. Default: - no custom domain and api mapping configuration

  • stage_variables (Optional[Mapping[str, str]]) – Stage variables for the stage. These are key-value pairs that you can define and use in your API routes. 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 (Union[ThrottleSettings, Dict[str, Any], None]) – Throttle settings for the routes of this stage. Default: - no throttling configuration

  • stage_name (str) – The name of the stage.

  • web_socket_api (IWebSocketApi) – The WebSocket API to which this stage is associated.

ExampleMetadata:

infused

Example:

from aws_cdk.aws_apigatewayv2_integrations import WebSocketLambdaIntegration

# message_handler: lambda.Function


web_socket_api = apigwv2.WebSocketApi(self, "mywsapi")
apigwv2.WebSocketStage(self, "mystage",
    web_socket_api=web_socket_api,
    stage_name="dev",
    auto_deploy=True
)
web_socket_api.add_route("sendMessage",
    integration=WebSocketLambdaIntegration("SendMessageIntegration", message_handler)
)

Attributes

access_log_settings

Settings for access logging.

Default:

  • No access logging

auto_deploy

Whether updates to an API automatically trigger a new deployment.

Default:

false

description

The description for the API stage.

Default:

  • no description

detailed_metrics_enabled

Specifies whether detailed metrics are enabled.

Default:

false

domain_mapping

The options for custom domain and api mapping.

Default:

  • no custom domain and api mapping configuration

stage_name

The name of the stage.

stage_variables

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

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.

Default:

  • no throttling configuration

web_socket_api

The WebSocket API to which this stage is associated.