software.amazon.awscdk.services.apigatewayv2

Class WebSocketApi

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigatewayv2.WebSocketApi

All Implemented Interfaces:

IDependable, IResource, IApi, IWebSocketApi, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:21.443Z")
 @Stability(value=Experimental)
public class WebSocketApi
extends Resource
implements IWebSocketApi, IApi

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

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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
	WebSocketApi(software.constructs.Construct scope, String id)
	WebSocketApi(software.constructs.Construct scope, String id, WebSocketApiProps props)
protected	WebSocketApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WebSocketApi(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
WebSocketRoute	addRoute(String routeKey, WebSocketRouteOptions options) (experimental) Add a new route.
String	getApiEndpoint() (experimental) The default endpoint for an API.
String	getApiId() (experimental) The identifier of this API Gateway API.
String	getWebSocketApiName() (experimental) A human friendly name for this WebSocket API.
Metric	metric(String metricName) (experimental) Return the given named metric for this Api Gateway.
Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this Api Gateway.
Metric	metricClientError() (experimental) Metric for the number of client-side errors captured in a given period.
Metric	metricClientError(MetricOptions props) (experimental) Metric for the number of client-side errors captured in a given period.
Metric	metricCount() (experimental) Metric for the total number API requests in a given period.
Metric	metricCount(MetricOptions props) (experimental) Metric for the total number API requests in a given period.
Metric	metricDataProcessed() (experimental) Metric for the amount of data processed in bytes.
Metric	metricDataProcessed(MetricOptions props) (experimental) Metric for the amount of data processed in bytes.
Metric	metricIntegrationLatency() (experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
Metric	metricIntegrationLatency(MetricOptions props) (experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
Metric	metricLatency() (experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.
Metric	metricLatency(MetricOptions props) (experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.
Metric	metricServerError() (experimental) Metric for the number of server-side errors captured in a given period.
Metric	metricServerError(MetricOptions props) (experimental) Metric for the number of server-side errors captured in a given period.

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 software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

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

getEnv, getStack

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

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

WebSocketApi

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

WebSocketApi

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

WebSocketApi

@Stability(value=Experimental)
public WebSocketApi(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @Nullable
                                                   WebSocketApiProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

WebSocketApi

@Stability(value=Experimental)
public WebSocketApi(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addRoute

@Stability(value=Experimental)
 @NotNull
public WebSocketRoute addRoute(@NotNull
                                                                        String routeKey,
                                                                        @NotNull
                                                                        WebSocketRouteOptions options)

(experimental) Add a new route.

Parameters:

routeKey - This parameter is required.

options - This parameter is required.

metric

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName,
                                                              @Nullable
                                                              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

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName)

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

Specified by:

metric in interface IApi

Parameters:

metricName - This parameter is required.

metricClientError

@Stability(value=Experimental)
 @NotNull
public Metric metricClientError(@Nullable
                                                                         MetricOptions props)

(experimental) Metric for the number of client-side errors captured in a given period.

Specified by:

metricClientError in interface IApi

Parameters:

props -

metricClientError

@Stability(value=Experimental)
 @NotNull
public Metric metricClientError()

(experimental) Metric for the number of client-side errors captured in a given period.

Specified by:

metricClientError in interface IApi

metricCount

@Stability(value=Experimental)
 @NotNull
public Metric metricCount(@Nullable
                                                                   MetricOptions props)

(experimental) Metric for the total number API requests in a given period.

Specified by:

metricCount in interface IApi

Parameters:

props -

metricCount

@Stability(value=Experimental)
 @NotNull
public Metric metricCount()

(experimental) Metric for the total number API requests in a given period.

Specified by:

metricCount in interface IApi

metricDataProcessed

@Stability(value=Experimental)
 @NotNull
public Metric metricDataProcessed(@Nullable
                                                                           MetricOptions props)

(experimental) Metric for the amount of data processed in bytes.

Specified by:

metricDataProcessed in interface IApi

Parameters:

props -

metricDataProcessed

@Stability(value=Experimental)
 @NotNull
public Metric metricDataProcessed()

(experimental) Metric for the amount of data processed in bytes.

Specified by:

metricDataProcessed in interface IApi

metricIntegrationLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricIntegrationLatency(@Nullable
                                                                                MetricOptions props)

(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

Specified by:

metricIntegrationLatency in interface IApi

Parameters:

props -

metricIntegrationLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricIntegrationLatency()

(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

Specified by:

metricIntegrationLatency in interface IApi

metricLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricLatency(@Nullable
                                                                     MetricOptions props)

(experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.

The latency includes the integration latency and other API Gateway overhead.

Specified by:

metricLatency in interface IApi

Parameters:

props -

metricLatency

@Stability(value=Experimental)
 @NotNull
public Metric metricLatency()

(experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.

The latency includes the integration latency and other API Gateway overhead.

Specified by:

metricLatency in interface IApi

metricServerError

@Stability(value=Experimental)
 @NotNull
public Metric metricServerError(@Nullable
                                                                         MetricOptions props)

(experimental) Metric for the number of server-side errors captured in a given period.

Specified by:

metricServerError in interface IApi

Parameters:

props -

metricServerError

@Stability(value=Experimental)
 @NotNull
public Metric metricServerError()

(experimental) Metric for the number of server-side errors captured in a given period.

Specified by:

metricServerError in interface IApi

getApiEndpoint

@Stability(value=Experimental)
 @NotNull
public String getApiEndpoint()

(experimental) The default endpoint for an API.

Specified by:

getApiEndpoint in interface IApi

getApiId

@Stability(value=Experimental)
 @NotNull
public String getApiId()

(experimental) The identifier of this API Gateway API.

Specified by:

getApiId in interface IApi

getWebSocketApiName

@Stability(value=Experimental)
 @Nullable
public String getWebSocketApiName()

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

Note that this is different from webSocketApiId.