Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data MetricStat = MetricStat' {}
- newMetricStat :: Metric -> Text -> MetricStat
- metricStat_unit :: Lens' MetricStat (Maybe Text)
- metricStat_metric :: Lens' MetricStat Metric
- metricStat_stat :: Lens' MetricStat Text
Documentation
data MetricStat Source #
This structure defines the CloudWatch metric to return, along with the statistic, period, and unit.
For more information about the CloudWatch terminology below, see Amazon CloudWatch concepts in the Amazon CloudWatch User Guide.
See: newMetricStat
smart constructor.
MetricStat' | |
|
Instances
Create a value of MetricStat
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:unit:MetricStat'
, metricStat_unit
- The unit to use for the returned data points. For a complete list of the
units that CloudWatch supports, see the
MetricDatum
data type in the Amazon CloudWatch API Reference.
$sel:metric:MetricStat'
, metricStat_metric
- The CloudWatch metric to return, including the metric name, namespace,
and dimensions. To get the exact metric name, namespace, and dimensions,
inspect the
Metric
object that is returned by a call to
ListMetrics.
$sel:stat:MetricStat'
, metricStat_stat
- The statistic to return. It can include any CloudWatch statistic or
extended statistic. For a list of valid values, see the table in
Statistics
in the Amazon CloudWatch User Guide.
The most commonly used metrics for predictive scaling are Average
and
Sum
.
metricStat_unit :: Lens' MetricStat (Maybe Text) Source #
The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
metricStat_metric :: Lens' MetricStat Metric Source #
The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
metricStat_stat :: Lens' MetricStat Text Source #
The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
The most commonly used metrics for predictive scaling are Average
and
Sum
.