software.amazon.awscdk.services.apigatewayv2

Class WebSocketApi

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigatewayv2.WebSocketApi

All Implemented Interfaces:

IConstruct, IDependable, IResource, IApi, IWebSocketApi

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.282Z")
public class WebSocketApi
extends Resource
implements IWebSocketApi, IApi

(experimental) Create a new API Gateway WebSocket API endpoint.

Example:

 import software.amazon.awscdk.services.apigatewayv2.integrations.WebSocketLambdaIntegration;
 Function messageHandler;
 WebSocketApi webSocketApi = new WebSocketApi(this, "mywsapi");
 webSocketApi.addRoute("sendmessage", WebSocketRouteOptions.builder()
         .integration(new WebSocketLambdaIntegration("SendMessageIntegration", messageHandler))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSocketApi.Builder (experimental) A fluent builder for WebSocketApi.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IWebSocketApi

IWebSocketApi.Jsii$Default, IWebSocketApi.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebSocketApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WebSocketApi(software.amazon.jsii.JsiiObjectRef objRef)
	WebSocketApi(software.constructs.Construct scope, java.lang.String id)
	WebSocketApi(software.constructs.Construct scope, java.lang.String id, WebSocketApiProps props)

Method Summary

Modifier and Type	Method and Description
WebSocketRoute	addRoute(java.lang.String routeKey, WebSocketRouteOptions options) (experimental) Add a new route.
static IWebSocketApi	fromWebSocketApiAttributes(software.constructs.Construct scope, java.lang.String id, WebSocketApiAttributes attrs) (experimental) Import an existing WebSocket API into this CDK app.
java.lang.String	getApiEndpoint() (experimental) The default endpoint for an API.
java.lang.String	getApiId() (experimental) The identifier of this API Gateway API.
java.lang.String	getWebSocketApiName() (experimental) A human friendly name for this WebSocket API.
Grant	grantManageConnections(IGrantable identity) (experimental) Grant access to the API Gateway management API for this WebSocket API to an IAM principal (Role/Group/User).
Metric	metric(java.lang.String metricName) (experimental) Return the given named metric for this Api Gateway.
Metric	metric(java.lang.String metricName, MetricOptions props) (experimental) Return the given named metric for this Api Gateway.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

WebSocketApi

protected WebSocketApi(software.amazon.jsii.JsiiObjectRef objRef)

WebSocketApi

protected WebSocketApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

WebSocketApi

public WebSocketApi(software.constructs.Construct scope,
                    java.lang.String id,
                    WebSocketApiProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

WebSocketApi

public WebSocketApi(software.constructs.Construct scope,
                    java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromWebSocketApiAttributes

public static IWebSocketApi fromWebSocketApiAttributes(software.constructs.Construct scope,
                                                       java.lang.String id,
                                                       WebSocketApiAttributes attrs)

(experimental) Import an existing WebSocket API into this CDK app.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addRoute

public WebSocketRoute addRoute(java.lang.String routeKey,
                               WebSocketRouteOptions options)

(experimental) Add a new route.

Parameters:

routeKey - This parameter is required.

options - This parameter is required.

grantManageConnections

public Grant grantManageConnections(IGrantable identity)

(experimental) Grant access to the API Gateway management API for this WebSocket API to an IAM principal (Role/Group/User).

Parameters:

identity - The principal. This parameter is required.

metric

public Metric metric(java.lang.String metricName,
                     MetricOptions props)

(experimental) Return the given named metric for this Api Gateway.

Specified by:

metric in interface IApi

Parameters:

metricName - This parameter is required.

props -

metric

public Metric metric(java.lang.String metricName)

(experimental) Return the given named metric for this Api Gateway.

Specified by:

metric in interface IApi

Parameters:

metricName - This parameter is required.

getApiEndpoint

public java.lang.String getApiEndpoint()

(experimental) The default endpoint for an API.

Specified by:

getApiEndpoint in interface IApi

getApiId

public java.lang.String getApiId()

(experimental) The identifier of this API Gateway API.

Specified by:

getApiId in interface IApi

getWebSocketApiName

public java.lang.String getWebSocketApiName()

(experimental) A human friendly name for this WebSocket API.

Note that this is different from webSocketApiId.