software.amazon.awscdk.services.apigatewayv2

Interface IHttpApi

All Superinterfaces:

IApi, IConstruct, IDependable, IResource

All Known Subinterfaces:

IHttpApi.Jsii$Default

All Known Implementing Classes:

HttpApi, IHttpApi.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:06.984Z")
public interface IHttpApi
extends IApi

(experimental) Represents an HTTP API.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
VpcLink	addVpcLink(VpcLinkProps options) (experimental) Add a new VpcLink.
java.lang.String	getHttpApiId() Deprecated. - use apiId instead
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.services.apigatewayv2.IApi

getApiEndpoint, getApiId, metric, metric

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

applyRemovalPolicy, getEnv, getStack

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

getNode

Method Detail

getHttpApiId

@Deprecated
java.lang.String getHttpApiId()

Deprecated. - use apiId instead

(deprecated) The identifier of this API Gateway HTTP API.

addVpcLink

VpcLink addVpcLink(VpcLinkProps options)

(experimental) Add a new VpcLink.

Parameters:

options - This parameter is required.

metricClientError

Metric metricClientError(MetricOptions props)

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

Default: - sum over 5 minutes

Parameters:

props -

metricClientError

Metric metricClientError()

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

Default: - sum over 5 minutes

metricCount

Metric metricCount(MetricOptions props)

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

Default: - SampleCount over 5 minutes

Parameters:

props -

metricCount

Metric metricCount()

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

Default: - SampleCount over 5 minutes

metricDataProcessed

Metric metricDataProcessed(MetricOptions props)

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

Default: - sum over 5 minutes

Parameters:

props -

metricDataProcessed

Metric metricDataProcessed()

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

Default: - sum over 5 minutes

metricIntegrationLatency

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.

Default: - no statistic

Parameters:

props -

metricIntegrationLatency

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

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.

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

Default: - no statistic

Parameters:

props -

metricLatency

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

Metric metricServerError(MetricOptions props)

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

Default: - sum over 5 minutes

Parameters:

props -

metricServerError

Metric metricServerError()

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

Default: - sum over 5 minutes