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

Amazonka.AutoScaling.Types.MetricStat

Description

Synopsis

data MetricStat = MetricStat' {
- unit :: Maybe Text
- metric :: Metric
- stat :: Text
}
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.

Constructors

MetricStat'

Fields

unit :: Maybe Text
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.
metric :: 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.
stat :: Text
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.

Instances

Instances details

ToQuery MetricStat Source #
Instance details Defined in Amazonka.AutoScaling.Types.MetricStat Methods toQuery :: MetricStat -> QueryString #
FromXML MetricStat Source #
Instance details Defined in Amazonka.AutoScaling.Types.MetricStat Methods parseXML :: [Node] -> Either String MetricStat #
Generic MetricStat Source #
Instance details Defined in Amazonka.AutoScaling.Types.MetricStat Associated Types type Rep MetricStat :: Type -> Type # Methods from :: MetricStat -> Rep MetricStat x # to :: Rep MetricStat x -> MetricStat #
Read MetricStat Source #
Instance details Defined in Amazonka.AutoScaling.Types.MetricStat Methods readsPrec :: Int -> ReadS MetricStat # readList :: ReadS [MetricStat] # readPrec :: ReadPrec MetricStat # readListPrec :: ReadPrec [MetricStat] #
Show MetricStat Source #
Instance details Defined in Amazonka.AutoScaling.Types.MetricStat Methods showsPrec :: Int -> MetricStat -> ShowS # show :: MetricStat -> String # showList :: [MetricStat] -> ShowS #
NFData MetricStat Source #
Instance details Defined in Amazonka.AutoScaling.Types.MetricStat Methods rnf :: MetricStat -> () #
Eq MetricStat Source #
Instance details Defined in Amazonka.AutoScaling.Types.MetricStat Methods (==) :: MetricStat -> MetricStat -> Bool # (/=) :: MetricStat -> MetricStat -> Bool #
Hashable MetricStat Source #
Instance details Defined in Amazonka.AutoScaling.Types.MetricStat Methods hashWithSalt :: Int -> MetricStat -> Int # hash :: MetricStat -> Int #
type Rep MetricStat Source #
Instance details Defined in Amazonka.AutoScaling.Types.MetricStat type Rep MetricStat = D1 ('MetaData "MetricStat" "Amazonka.AutoScaling.Types.MetricStat" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "MetricStat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Metric) :: S1 ('MetaSel ('Just "stat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newMetricStat Source #

Arguments

:: Metric	`$sel:metric:MetricStat'`
-> Text	`$sel:stat:MetricStat'`
-> MetricStat

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.