Interface IHttpStage
- All Superinterfaces:
software.constructs.IConstruct
,software.constructs.IDependable
,IResource
,IStage
,software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
IHttpStage.Jsii$Default
- All Known Implementing Classes:
HttpStage
,IHttpStage.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-09-11T18:01:10.781Z")
@Stability(Stable)
public interface IHttpStage
extends software.amazon.jsii.JsiiSerializable, IStage
Represents the HttpStage.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
Internal default implementation forIHttpStage
.static final class
A proxy class which represents a concrete javascript instance of this type. -
Method Summary
Modifier and TypeMethodDescriptiongetApi()
The API this stage is associated to.The custom domain URL to this stage.Metric for the number of client-side errors captured in a given period.metricClientError
(MetricOptions props) Metric for the number of client-side errors captured in a given period.Metric for the total number API requests in a given period.metricCount
(MetricOptions props) Metric for the total number API requests in a given period.Metric for the amount of data processed in bytes.metricDataProcessed
(MetricOptions props) Metric for the amount of data processed in bytes.Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.The time between when API Gateway receives a request from a client and when it returns a response to the client.metricLatency
(MetricOptions props) The time between when API Gateway receives a request from a client and when it returns a response to the client.Metric for the number of server-side errors captured in a given period.metricServerError
(MetricOptions props) Metric for the number of server-side errors captured in a given period.Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.IStage
getStageName, getUrl, metric, metric
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApi
The API this stage is associated to. -
getDomainUrl
The custom domain URL to this stage. -
metricClientError
Metric for the number of client-side errors captured in a given period.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricClientError
Metric for the number of client-side errors captured in a given period.Default: - sum over 5 minutes
-
metricCount
Metric for the total number API requests in a given period.Default: - SampleCount over 5 minutes
- Parameters:
props
-
-
metricCount
Metric for the total number API requests in a given period.Default: - SampleCount over 5 minutes
-
metricDataProcessed
Metric for the amount of data processed in bytes.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricDataProcessed
Metric for the amount of data processed in bytes.Default: - sum over 5 minutes
-
metricIntegrationLatency
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 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
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
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 for the number of server-side errors captured in a given period.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricServerError
Metric for the number of server-side errors captured in a given period.Default: - sum over 5 minutes
-