WebSocketApiAttributes

class aws_cdk.aws_apigatewayv2.WebSocketApiAttributes(*, web_socket_id, api_endpoint=None)

Bases: object

Attributes for importing a WebSocketApi into the CDK.

Parameters:

  • web_socket_id (str) – The identifier of the WebSocketApi.

  • api_endpoint (Optional[str]) – The endpoint URL of the WebSocketApi. Default: - throw san error if apiEndpoint is accessed.

ExampleMetadata:

infused

Example:

web_socket_api = apigwv2.WebSocketApi.from_web_socket_api_attributes(self, "mywsapi", web_socket_id="api-1234")

Attributes

api_endpoint

The endpoint URL of the WebSocketApi.

Default:

  • throw san error if apiEndpoint is accessed.

web_socket_id

The identifier of the WebSocketApi.