WebSocketApiAttributes¶
-
class
aws_cdk.aws_apigatewayv2.WebSocketApiAttributes(*, web_socket_id, api_endpoint=None)¶ Bases:
object(experimental) Attributes for importing a WebSocketApi into the CDK.
- Parameters
web_socket_id (
str) – (experimental) The identifier of the WebSocketApi.api_endpoint (
Optional[str]) – (experimental) The endpoint URL of the WebSocketApi. Default: - throw san error if apiEndpoint is accessed.
- Stability
experimental
- ExampleMetadata
infused
Example:
web_socket_api = apigwv2.WebSocketApi.from_web_socket_api_attributes(self, "mywsapi", web_socket_id="api-1234")
Attributes
-
api_endpoint¶ (experimental) The endpoint URL of the WebSocketApi.
- Default
throw san error if apiEndpoint is accessed.
- Stability
experimental
- Return type
Optional[str]
-
web_socket_id¶ (experimental) The identifier of the WebSocketApi.
- Stability
experimental
- Return type
str