Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AutoScalingPlans.Types.CustomizedScalingMetricSpecification

Description

Synopsis

Documentation

data CustomizedScalingMetricSpecification Source #

Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.

To create your customized scaling metric specification:

Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.
Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.

See: newCustomizedScalingMetricSpecification smart constructor.

Constructors

CustomizedScalingMetricSpecification'

Fields

dimensions :: Maybe [MetricDimension]
The dimensions of the metric.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.
unit :: Maybe Text
The unit of the metric.
metricName :: Text
The name of the metric.
namespace :: Text
The namespace of the metric.
statistic :: MetricStatistic
The statistic of the metric.

Instances

Instances details

Eq CustomizedScalingMetricSpecification Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.CustomizedScalingMetricSpecification Methods (==) :: CustomizedScalingMetricSpecification -> CustomizedScalingMetricSpecification -> Bool # (/=) :: CustomizedScalingMetricSpecification -> CustomizedScalingMetricSpecification -> Bool #
Read CustomizedScalingMetricSpecification Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.CustomizedScalingMetricSpecification Methods readsPrec :: Int -> ReadS CustomizedScalingMetricSpecification # readList :: ReadS [CustomizedScalingMetricSpecification] # readPrec :: ReadPrec CustomizedScalingMetricSpecification # readListPrec :: ReadPrec [CustomizedScalingMetricSpecification] #
Show CustomizedScalingMetricSpecification Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.CustomizedScalingMetricSpecification Methods showsPrec :: Int -> CustomizedScalingMetricSpecification -> ShowS # show :: CustomizedScalingMetricSpecification -> String # showList :: [CustomizedScalingMetricSpecification] -> ShowS #
Generic CustomizedScalingMetricSpecification Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.CustomizedScalingMetricSpecification Associated Types type Rep CustomizedScalingMetricSpecification :: Type -> Type # Methods from :: CustomizedScalingMetricSpecification -> Rep CustomizedScalingMetricSpecification x # to :: Rep CustomizedScalingMetricSpecification x -> CustomizedScalingMetricSpecification #
NFData CustomizedScalingMetricSpecification Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.CustomizedScalingMetricSpecification Methods rnf :: CustomizedScalingMetricSpecification -> () #
Hashable CustomizedScalingMetricSpecification Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.CustomizedScalingMetricSpecification Methods hashWithSalt :: Int -> CustomizedScalingMetricSpecification -> Int # hash :: CustomizedScalingMetricSpecification -> Int #
ToJSON CustomizedScalingMetricSpecification Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.CustomizedScalingMetricSpecification Methods toJSON :: CustomizedScalingMetricSpecification -> Value # toEncoding :: CustomizedScalingMetricSpecification -> Encoding # toJSONList :: [CustomizedScalingMetricSpecification] -> Value # toEncodingList :: [CustomizedScalingMetricSpecification] -> Encoding #
FromJSON CustomizedScalingMetricSpecification Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.CustomizedScalingMetricSpecification Methods parseJSON :: Value -> Parser CustomizedScalingMetricSpecification # parseJSONList :: Value -> Parser [CustomizedScalingMetricSpecification] #
type Rep CustomizedScalingMetricSpecification Source #
Instance details Defined in Amazonka.AutoScalingPlans.Types.CustomizedScalingMetricSpecification type Rep CustomizedScalingMetricSpecification = D1 ('MetaData "CustomizedScalingMetricSpecification" "Amazonka.AutoScalingPlans.Types.CustomizedScalingMetricSpecification" "libZSservicesZSamazonka-autoscaling-plansZSamazonka-autoscaling-plans" 'False) (C1 ('MetaCons "CustomizedScalingMetricSpecification'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricDimension])) :: S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "statistic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricStatistic)))))

newCustomizedScalingMetricSpecification Source #

Arguments

:: Text	`$sel:metricName:CustomizedScalingMetricSpecification'`
-> Text	`$sel:namespace:CustomizedScalingMetricSpecification'`
-> MetricStatistic	`$sel:statistic:CustomizedScalingMetricSpecification'`
-> CustomizedScalingMetricSpecification

Create a value of CustomizedScalingMetricSpecification 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:dimensions:CustomizedScalingMetricSpecification', customizedScalingMetricSpecification_dimensions - The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.

$sel:unit:CustomizedScalingMetricSpecification', customizedScalingMetricSpecification_unit - The unit of the metric.

$sel:metricName:CustomizedScalingMetricSpecification', customizedScalingMetricSpecification_metricName - The name of the metric.

$sel:namespace:CustomizedScalingMetricSpecification', customizedScalingMetricSpecification_namespace - The namespace of the metric.

$sel:statistic:CustomizedScalingMetricSpecification', customizedScalingMetricSpecification_statistic - The statistic of the metric.

customizedScalingMetricSpecification_dimensions :: Lens' CustomizedScalingMetricSpecification (Maybe [MetricDimension]) Source #

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.

customizedScalingMetricSpecification_unit :: Lens' CustomizedScalingMetricSpecification (Maybe Text) Source #

The unit of the metric.

customizedScalingMetricSpecification_metricName :: Lens' CustomizedScalingMetricSpecification Text Source #

The name of the metric.

customizedScalingMetricSpecification_namespace :: Lens' CustomizedScalingMetricSpecification Text Source #

The namespace of the metric.

customizedScalingMetricSpecification_statistic :: Lens' CustomizedScalingMetricSpecification MetricStatistic Source #

The statistic of the metric.