software.amazon.awscdk.services.apigatewayv2.alpha

Interface WebSocketApiAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WebSocketApiAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-15T19:53:17.427Z")
 @Stability(value=Experimental)
public interface WebSocketApiAttributes
extends software.amazon.jsii.JsiiSerializable

(experimental) Attributes for importing a WebSocketApi into the CDK.

Example:

 IWebSocketApi webSocketApi = WebSocketApi.fromWebSocketApiAttributes(this, "mywsapi", WebSocketApiAttributes.builder().webSocketId("api-1234").build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WebSocketApiAttributes.Builder A builder for WebSocketApiAttributes
static class	WebSocketApiAttributes.Jsii$Proxy An implementation for WebSocketApiAttributes

Method Summary

Modifier and Type	Method and Description
static WebSocketApiAttributes.Builder	builder()
default String	getApiEndpoint() (experimental) The endpoint URL of the WebSocketApi.
String	getWebSocketId() (experimental) The identifier of the WebSocketApi.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getWebSocketId

@Stability(value=Experimental)
 @NotNull
String getWebSocketId()

(experimental) The identifier of the WebSocketApi.

getApiEndpoint

@Stability(value=Experimental)
 @Nullable
default String getApiEndpoint()

(experimental) The endpoint URL of the WebSocketApi.

Default: - throw san error if apiEndpoint is accessed.

builder

@Stability(value=Experimental)
static WebSocketApiAttributes.Builder builder()

Returns:

a WebSocketApiAttributes.Builder of WebSocketApiAttributes