software.amazon.awscdk.services.apigatewayv2

Interface IApi

All Superinterfaces:

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

All Known Subinterfaces:

IApi.Jsii$Default, IHttpApi, IHttpApi.Jsii$Default, IWebSocketApi, IWebSocketApi.Jsii$Default

All Known Implementing Classes:

HttpApi, IApi.Jsii$Proxy, IHttpApi.Jsii$Proxy, IWebSocketApi.Jsii$Proxy, WebSocketApi

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:21.424Z")
 @Stability(value=Experimental)
public interface IApi
extends software.amazon.jsii.JsiiSerializable, IResource

(experimental) Represents a API Gateway HTTP/WebSocket API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IApi.Jsii$Default Internal default implementation for IApi.
static class	IApi.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
String	getApiEndpoint() (experimental) The default endpoint for an API.
String	getApiId() (experimental) The identifier of this API Gateway 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 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

Method Detail

getApiEndpoint

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

(experimental) The default endpoint for an API.

getApiId

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

(experimental) The identifier of this API Gateway API.

metric

@Stability(value=Experimental)
 @NotNull
Metric metric(@NotNull
                                                       String metricName,
                                                       @Nullable
                                                       MetricOptions props)

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

Default: - average over 5 minutes

Parameters:

metricName - This parameter is required.

props -

metric

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

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

Default: - average over 5 minutes

Parameters:

metricName - This parameter is required.

metricClientError

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

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

Default: - sum over 5 minutes

Parameters:

props -

metricClientError

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

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

Default: - sum over 5 minutes

metricCount

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

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

Default: - SampleCount over 5 minutes

Parameters:

props -

metricCount

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

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

Default: - SampleCount over 5 minutes

metricDataProcessed

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

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

Default: - sum over 5 minutes

Parameters:

props -

metricDataProcessed

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

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

Default: - sum over 5 minutes

metricIntegrationLatency

@Stability(value=Experimental)
 @NotNull
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.

Default: - no statistic

Parameters:

props -

metricIntegrationLatency

@Stability(value=Experimental)
 @NotNull
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.

Default: - no statistic

metricLatency

@Stability(value=Experimental)
 @NotNull
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.

Default: - no statistic

Parameters:

props -

metricLatency

@Stability(value=Experimental)
 @NotNull
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.

Default: - no statistic

metricServerError

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

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

Default: - sum over 5 minutes

Parameters:

props -

metricServerError

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

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

Default: - sum over 5 minutes