Package software.amazon.awscdk.services.apigatewayv2

Interface WebSocketApiAttributes

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

WebSocketApiAttributes.Jsii$Proxy

@Generated(value="jsii-pacmak/1.130.0 (build 048a5ee)",
           date="2026-05-21T17:27:29.388Z")
@Stability(Stable)
public interface WebSocketApiAttributes
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	WebSocketApiAttributes.Builder	A builder for WebSocketApiAttributes
static final class	WebSocketApiAttributes.Jsii$Proxy	An implementation for WebSocketApiAttributes

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getWebSocketId

@Stability(Stable)
@NotNull
String getWebSocketId()

The identifier of the WebSocketApi.

getApiEndpoint

@Stability(Stable)
@Nullable
default String getApiEndpoint()

The endpoint URL of the WebSocketApi.

Default: - throw san error if apiEndpoint is accessed.

builder

@Stability(Stable)
static WebSocketApiAttributes.Builder builder()

Returns:

a WebSocketApiAttributes.Builder of WebSocketApiAttributes