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.ApplicationAutoScaling.Types.CustomizedMetricSpecification

Description

Documentation

data CustomizedMetricSpecification Source #

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.

For information about the available metrics for a service, see Amazon Web Services Services That Publish CloudWatch Metrics in the Amazon CloudWatch User Guide.

To create your customized 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, and increase when capacity decreases.

For more information about CloudWatch, see Amazon CloudWatch Concepts.

See: newCustomizedMetricSpecification smart constructor.

Constructors

CustomizedMetricSpecification'
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 scaling policy. 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 CustomizedMetricSpecification Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification Methods (==) :: CustomizedMetricSpecification -> CustomizedMetricSpecification -> Bool # (/=) :: CustomizedMetricSpecification -> CustomizedMetricSpecification -> Bool #
Read CustomizedMetricSpecification Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification Methods readsPrec :: Int -> ReadS CustomizedMetricSpecification # readList :: ReadS [CustomizedMetricSpecification] # readPrec :: ReadPrec CustomizedMetricSpecification # readListPrec :: ReadPrec [CustomizedMetricSpecification] #
Show CustomizedMetricSpecification Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification Methods showsPrec :: Int -> CustomizedMetricSpecification -> ShowS # show :: CustomizedMetricSpecification -> String # showList :: [CustomizedMetricSpecification] -> ShowS #
Generic CustomizedMetricSpecification Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification Associated Types type Rep CustomizedMetricSpecification :: Type -> Type # Methods from :: CustomizedMetricSpecification -> Rep CustomizedMetricSpecification x # to :: Rep CustomizedMetricSpecification x -> CustomizedMetricSpecification #
NFData CustomizedMetricSpecification Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification Methods rnf :: CustomizedMetricSpecification -> () #
Hashable CustomizedMetricSpecification Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification Methods hashWithSalt :: Int -> CustomizedMetricSpecification -> Int # hash :: CustomizedMetricSpecification -> Int #
ToJSON CustomizedMetricSpecification Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification Methods toJSON :: CustomizedMetricSpecification -> Value # toEncoding :: CustomizedMetricSpecification -> Encoding # toJSONList :: [CustomizedMetricSpecification] -> Value # toEncodingList :: [CustomizedMetricSpecification] -> Encoding #
FromJSON CustomizedMetricSpecification Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification Methods parseJSON :: Value -> Parser CustomizedMetricSpecification # parseJSONList :: Value -> Parser [CustomizedMetricSpecification] #
type Rep CustomizedMetricSpecification Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification type Rep CustomizedMetricSpecification = D1 ('MetaData "CustomizedMetricSpecification" "Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification" "libZSservicesZSamazonka-application-autoscalingZSamazonka-application-autoscaling" 'False) (C1 ('MetaCons "CustomizedMetricSpecification'" '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)))))

newCustomizedMetricSpecification Source #

Arguments

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

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

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

$sel:unit:CustomizedMetricSpecification', customizedMetricSpecification_unit - The unit of the metric.

$sel:metricName:CustomizedMetricSpecification', customizedMetricSpecification_metricName - The name of the metric.

$sel:namespace:CustomizedMetricSpecification', customizedMetricSpecification_namespace - The namespace of the metric.

$sel:statistic:CustomizedMetricSpecification', customizedMetricSpecification_statistic - The statistic of the metric.

customizedMetricSpecification_dimensions :: Lens' CustomizedMetricSpecification (Maybe [MetricDimension]) Source #

The dimensions of the metric.

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

customizedMetricSpecification_unit :: Lens' CustomizedMetricSpecification (Maybe Text) Source #

The unit of the metric.

customizedMetricSpecification_metricName :: Lens' CustomizedMetricSpecification Text Source #

The name of the metric.

customizedMetricSpecification_namespace :: Lens' CustomizedMetricSpecification Text Source #

The namespace of the metric.

customizedMetricSpecification_statistic :: Lens' CustomizedMetricSpecification MetricStatistic Source #

The statistic of the metric.