Interface IHttpStage
- All Superinterfaces:
IConstruct
,software.constructs.IConstruct
,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.84.0 (build 5404dcf)",
date="2023-06-19T16:30:43.301Z")
@Stability(Experimental)
public interface IHttpStage
extends software.amazon.jsii.JsiiSerializable, IStage
(experimental) 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()
(experimental) The API this stage is associated to.(experimental) The custom domain URL to this stage.(experimental) Metric for the number of client-side errors captured in a given period.metricClientError
(MetricOptions props) (experimental) Metric for the number of client-side errors captured in a given period.(experimental) Metric for the total number API requests in a given period.metricCount
(MetricOptions props) (experimental) Metric for the total number API requests in a given period.(experimental) Metric for the amount of data processed in bytes.metricDataProcessed
(MetricOptions props) (experimental) Metric for the amount of data processed in bytes.(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.(experimental) Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.(experimental) The time between when API Gateway receives a request from a client and when it returns a response to the client.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.(experimental) Metric for the number of server-side errors captured in a given period.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.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.core.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
(experimental) The API this stage is associated to. -
getDomainUrl
(experimental) The custom domain URL to this stage. -
metricClientError
(experimental) Metric for the number of client-side errors captured in a given period.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricClientError
(experimental) Metric for the number of client-side errors captured in a given period.Default: - sum over 5 minutes
-
metricCount
(experimental) Metric for the total number API requests in a given period.Default: - SampleCount over 5 minutes
- Parameters:
props
-
-
metricCount
(experimental) Metric for the total number API requests in a given period.Default: - SampleCount over 5 minutes
-
metricDataProcessed
(experimental) Metric for the amount of data processed in bytes.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricDataProcessed
(experimental) Metric for the amount of data processed in bytes.Default: - sum over 5 minutes
-
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
- Parameters:
props
-
-
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
(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
(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
(experimental) Metric for the number of server-side errors captured in a given period.Default: - sum over 5 minutes
- Parameters:
props
-
-
metricServerError
(experimental) Metric for the number of server-side errors captured in a given period.Default: - sum over 5 minutes
-