WebSocketStageAttributes

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

Bases: aws_cdk.aws_apigatewayv2.StageAttributes

(experimental) The attributes used to import existing WebSocketStage.

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

  • api (IWebSocketApi) – (experimental) The API to which this stage is associated.

Stability

experimental

ExampleMetadata

fixture=_generated

Example:

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

# web_socket_api is of type WebSocketApi

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

Attributes

api

(experimental) The API to which this stage is associated.

Stability

experimental

Return type

IWebSocketApi

stage_name

(experimental) The name of the stage.

Stability

experimental

Return type

str