WebSocketStageAttributes

class aws_cdk.aws_apigatewayv2.WebSocketStageAttributes(*, stage_name, api)

Bases: StageAttributes

The attributes used to import existing WebSocketStage.

Parameters:

stage_name (str) – The name of the stage.
api (IWebSocketApi) – The API to which this stage is associated.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apigatewayv2 as apigatewayv2

# web_socket_api: apigatewayv2.WebSocketApi

web_socket_stage_attributes = apigatewayv2.WebSocketStageAttributes(
    api=web_socket_api,
    stage_name="stageName"
)

Attributes

api: The API to which this stage is associated.

stage_name: The name of the stage.