Class WebSocketApiAttributes
(experimental) Attributes for importing a WebSocketApi into the CDK.
Inheritance
System.Object
WebSocketApiAttributes
Implements
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class WebSocketApiAttributes : Object, IWebSocketApiAttributes
Syntax (vb)
Public Class WebSocketApiAttributes
Inherits Object
Implements IWebSocketApiAttributes
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
var webSocketApi = WebSocketApi.FromWebSocketApiAttributes(this, "mywsapi", new WebSocketApiAttributes { WebSocketId = "api-1234" });
Synopsis
Constructors
WebSocketApiAttributes() |
Properties
ApiEndpoint | (experimental) The endpoint URL of the WebSocketApi. |
WebSocketId | (experimental) The identifier of the WebSocketApi. |
Constructors
WebSocketApiAttributes()
public WebSocketApiAttributes()
Properties
ApiEndpoint
(experimental) The endpoint URL of the WebSocketApi.
public string ApiEndpoint { get; set; }
Property Value
System.String
Remarks
Default: - throw san error if apiEndpoint is accessed.
Stability: Experimental
WebSocketId
(experimental) The identifier of the WebSocketApi.
public string WebSocketId { get; set; }
Property Value
System.String
Remarks
Stability: Experimental