{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.ApplicationAutoScaling.Types.CustomizedMetricSpecification where

import Amazonka.ApplicationAutoScaling.Types.MetricDimension
import Amazonka.ApplicationAutoScaling.Types.MetricStatistic
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | 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
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html 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
--     <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html 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 an example of how creating new metrics can be useful, see
-- <https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-using-sqs-queue.html Scaling based on Amazon SQS>
-- in the /Amazon EC2 Auto Scaling User Guide/. This topic mentions Auto
-- Scaling groups, but the same scenario for Amazon SQS can apply to the
-- target tracking scaling policies that you create for a Spot Fleet by
-- using the Application Auto Scaling API.
--
-- For more information about the CloudWatch terminology below, see
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html Amazon CloudWatch concepts>
-- in the /Amazon CloudWatch User Guide/.
--
-- /See:/ 'newCustomizedMetricSpecification' smart constructor.
data CustomizedMetricSpecification = CustomizedMetricSpecification'
  { -- | The dimensions of the metric.
    --
    -- Conditional: If you published your metric with dimensions, you must
    -- specify the same dimensions in your scaling policy.
    CustomizedMetricSpecification -> Maybe [MetricDimension]
dimensions :: Prelude.Maybe [MetricDimension],
    -- | The unit of the metric. For a complete list of the units that CloudWatch
    -- supports, see the
    -- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html MetricDatum>
    -- data type in the /Amazon CloudWatch API Reference/.
    CustomizedMetricSpecification -> Maybe Text
unit :: Prelude.Maybe Prelude.Text,
    -- | The name of the metric. To get the exact metric name, namespace, and
    -- dimensions, inspect the
    -- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html Metric>
    -- object that is returned by a call to
    -- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html ListMetrics>.
    CustomizedMetricSpecification -> Text
metricName :: Prelude.Text,
    -- | The namespace of the metric.
    CustomizedMetricSpecification -> Text
namespace :: Prelude.Text,
    -- | The statistic of the metric.
    CustomizedMetricSpecification -> MetricStatistic
statistic :: MetricStatistic
  }
  deriving (CustomizedMetricSpecification
-> CustomizedMetricSpecification -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CustomizedMetricSpecification
-> CustomizedMetricSpecification -> Bool
$c/= :: CustomizedMetricSpecification
-> CustomizedMetricSpecification -> Bool
== :: CustomizedMetricSpecification
-> CustomizedMetricSpecification -> Bool
$c== :: CustomizedMetricSpecification
-> CustomizedMetricSpecification -> Bool
Prelude.Eq, ReadPrec [CustomizedMetricSpecification]
ReadPrec CustomizedMetricSpecification
Int -> ReadS CustomizedMetricSpecification
ReadS [CustomizedMetricSpecification]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CustomizedMetricSpecification]
$creadListPrec :: ReadPrec [CustomizedMetricSpecification]
readPrec :: ReadPrec CustomizedMetricSpecification
$creadPrec :: ReadPrec CustomizedMetricSpecification
readList :: ReadS [CustomizedMetricSpecification]
$creadList :: ReadS [CustomizedMetricSpecification]
readsPrec :: Int -> ReadS CustomizedMetricSpecification
$creadsPrec :: Int -> ReadS CustomizedMetricSpecification
Prelude.Read, Int -> CustomizedMetricSpecification -> ShowS
[CustomizedMetricSpecification] -> ShowS
CustomizedMetricSpecification -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CustomizedMetricSpecification] -> ShowS
$cshowList :: [CustomizedMetricSpecification] -> ShowS
show :: CustomizedMetricSpecification -> String
$cshow :: CustomizedMetricSpecification -> String
showsPrec :: Int -> CustomizedMetricSpecification -> ShowS
$cshowsPrec :: Int -> CustomizedMetricSpecification -> ShowS
Prelude.Show, forall x.
Rep CustomizedMetricSpecification x
-> CustomizedMetricSpecification
forall x.
CustomizedMetricSpecification
-> Rep CustomizedMetricSpecification x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CustomizedMetricSpecification x
-> CustomizedMetricSpecification
$cfrom :: forall x.
CustomizedMetricSpecification
-> Rep CustomizedMetricSpecification x
Prelude.Generic)

-- |
-- Create a value of 'CustomizedMetricSpecification' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'dimensions', '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.
--
-- 'unit', 'customizedMetricSpecification_unit' - The unit of the metric. For a complete list of the units that CloudWatch
-- supports, see the
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html MetricDatum>
-- data type in the /Amazon CloudWatch API Reference/.
--
-- 'metricName', 'customizedMetricSpecification_metricName' - The name of the metric. To get the exact metric name, namespace, and
-- dimensions, inspect the
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html Metric>
-- object that is returned by a call to
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html ListMetrics>.
--
-- 'namespace', 'customizedMetricSpecification_namespace' - The namespace of the metric.
--
-- 'statistic', 'customizedMetricSpecification_statistic' - The statistic of the metric.
newCustomizedMetricSpecification ::
  -- | 'metricName'
  Prelude.Text ->
  -- | 'namespace'
  Prelude.Text ->
  -- | 'statistic'
  MetricStatistic ->
  CustomizedMetricSpecification
newCustomizedMetricSpecification :: Text -> Text -> MetricStatistic -> CustomizedMetricSpecification
newCustomizedMetricSpecification
  Text
pMetricName_
  Text
pNamespace_
  MetricStatistic
pStatistic_ =
    CustomizedMetricSpecification'
      { $sel:dimensions:CustomizedMetricSpecification' :: Maybe [MetricDimension]
dimensions =
          forall a. Maybe a
Prelude.Nothing,
        $sel:unit:CustomizedMetricSpecification' :: Maybe Text
unit = forall a. Maybe a
Prelude.Nothing,
        $sel:metricName:CustomizedMetricSpecification' :: Text
metricName = Text
pMetricName_,
        $sel:namespace:CustomizedMetricSpecification' :: Text
namespace = Text
pNamespace_,
        $sel:statistic:CustomizedMetricSpecification' :: MetricStatistic
statistic = MetricStatistic
pStatistic_
      }

-- | The dimensions of the metric.
--
-- Conditional: If you published your metric with dimensions, you must
-- specify the same dimensions in your scaling policy.
customizedMetricSpecification_dimensions :: Lens.Lens' CustomizedMetricSpecification (Prelude.Maybe [MetricDimension])
customizedMetricSpecification_dimensions :: Lens' CustomizedMetricSpecification (Maybe [MetricDimension])
customizedMetricSpecification_dimensions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomizedMetricSpecification' {Maybe [MetricDimension]
dimensions :: Maybe [MetricDimension]
$sel:dimensions:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Maybe [MetricDimension]
dimensions} -> Maybe [MetricDimension]
dimensions) (\s :: CustomizedMetricSpecification
s@CustomizedMetricSpecification' {} Maybe [MetricDimension]
a -> CustomizedMetricSpecification
s {$sel:dimensions:CustomizedMetricSpecification' :: Maybe [MetricDimension]
dimensions = Maybe [MetricDimension]
a} :: CustomizedMetricSpecification) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The unit of the metric. For a complete list of the units that CloudWatch
-- supports, see the
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html MetricDatum>
-- data type in the /Amazon CloudWatch API Reference/.
customizedMetricSpecification_unit :: Lens.Lens' CustomizedMetricSpecification (Prelude.Maybe Prelude.Text)
customizedMetricSpecification_unit :: Lens' CustomizedMetricSpecification (Maybe Text)
customizedMetricSpecification_unit = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomizedMetricSpecification' {Maybe Text
unit :: Maybe Text
$sel:unit:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Maybe Text
unit} -> Maybe Text
unit) (\s :: CustomizedMetricSpecification
s@CustomizedMetricSpecification' {} Maybe Text
a -> CustomizedMetricSpecification
s {$sel:unit:CustomizedMetricSpecification' :: Maybe Text
unit = Maybe Text
a} :: CustomizedMetricSpecification)

-- | The name of the metric. To get the exact metric name, namespace, and
-- dimensions, inspect the
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Metric.html Metric>
-- object that is returned by a call to
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_ListMetrics.html ListMetrics>.
customizedMetricSpecification_metricName :: Lens.Lens' CustomizedMetricSpecification Prelude.Text
customizedMetricSpecification_metricName :: Lens' CustomizedMetricSpecification Text
customizedMetricSpecification_metricName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomizedMetricSpecification' {Text
metricName :: Text
$sel:metricName:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Text
metricName} -> Text
metricName) (\s :: CustomizedMetricSpecification
s@CustomizedMetricSpecification' {} Text
a -> CustomizedMetricSpecification
s {$sel:metricName:CustomizedMetricSpecification' :: Text
metricName = Text
a} :: CustomizedMetricSpecification)

-- | The namespace of the metric.
customizedMetricSpecification_namespace :: Lens.Lens' CustomizedMetricSpecification Prelude.Text
customizedMetricSpecification_namespace :: Lens' CustomizedMetricSpecification Text
customizedMetricSpecification_namespace = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomizedMetricSpecification' {Text
namespace :: Text
$sel:namespace:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Text
namespace} -> Text
namespace) (\s :: CustomizedMetricSpecification
s@CustomizedMetricSpecification' {} Text
a -> CustomizedMetricSpecification
s {$sel:namespace:CustomizedMetricSpecification' :: Text
namespace = Text
a} :: CustomizedMetricSpecification)

-- | The statistic of the metric.
customizedMetricSpecification_statistic :: Lens.Lens' CustomizedMetricSpecification MetricStatistic
customizedMetricSpecification_statistic :: Lens' CustomizedMetricSpecification MetricStatistic
customizedMetricSpecification_statistic = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CustomizedMetricSpecification' {MetricStatistic
statistic :: MetricStatistic
$sel:statistic:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> MetricStatistic
statistic} -> MetricStatistic
statistic) (\s :: CustomizedMetricSpecification
s@CustomizedMetricSpecification' {} MetricStatistic
a -> CustomizedMetricSpecification
s {$sel:statistic:CustomizedMetricSpecification' :: MetricStatistic
statistic = MetricStatistic
a} :: CustomizedMetricSpecification)

instance Data.FromJSON CustomizedMetricSpecification where
  parseJSON :: Value -> Parser CustomizedMetricSpecification
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CustomizedMetricSpecification"
      ( \Object
x ->
          Maybe [MetricDimension]
-> Maybe Text
-> Text
-> Text
-> MetricStatistic
-> CustomizedMetricSpecification
CustomizedMetricSpecification'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Dimensions" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Unit")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"MetricName")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Namespace")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Statistic")
      )

instance
  Prelude.Hashable
    CustomizedMetricSpecification
  where
  hashWithSalt :: Int -> CustomizedMetricSpecification -> Int
hashWithSalt Int
_salt CustomizedMetricSpecification' {Maybe [MetricDimension]
Maybe Text
Text
MetricStatistic
statistic :: MetricStatistic
namespace :: Text
metricName :: Text
unit :: Maybe Text
dimensions :: Maybe [MetricDimension]
$sel:statistic:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> MetricStatistic
$sel:namespace:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Text
$sel:metricName:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Text
$sel:unit:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Maybe Text
$sel:dimensions:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Maybe [MetricDimension]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [MetricDimension]
dimensions
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
unit
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
metricName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
namespace
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` MetricStatistic
statistic

instance Prelude.NFData CustomizedMetricSpecification where
  rnf :: CustomizedMetricSpecification -> ()
rnf CustomizedMetricSpecification' {Maybe [MetricDimension]
Maybe Text
Text
MetricStatistic
statistic :: MetricStatistic
namespace :: Text
metricName :: Text
unit :: Maybe Text
dimensions :: Maybe [MetricDimension]
$sel:statistic:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> MetricStatistic
$sel:namespace:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Text
$sel:metricName:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Text
$sel:unit:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Maybe Text
$sel:dimensions:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Maybe [MetricDimension]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [MetricDimension]
dimensions
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
unit
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
metricName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
namespace
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf MetricStatistic
statistic

instance Data.ToJSON CustomizedMetricSpecification where
  toJSON :: CustomizedMetricSpecification -> Value
toJSON CustomizedMetricSpecification' {Maybe [MetricDimension]
Maybe Text
Text
MetricStatistic
statistic :: MetricStatistic
namespace :: Text
metricName :: Text
unit :: Maybe Text
dimensions :: Maybe [MetricDimension]
$sel:statistic:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> MetricStatistic
$sel:namespace:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Text
$sel:metricName:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Text
$sel:unit:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Maybe Text
$sel:dimensions:CustomizedMetricSpecification' :: CustomizedMetricSpecification -> Maybe [MetricDimension]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Dimensions" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [MetricDimension]
dimensions,
            (Key
"Unit" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
unit,
            forall a. a -> Maybe a
Prelude.Just (Key
"MetricName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
metricName),
            forall a. a -> Maybe a
Prelude.Just (Key
"Namespace" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
namespace),
            forall a. a -> Maybe a
Prelude.Just (Key
"Statistic" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= MetricStatistic
statistic)
          ]
      )