{-# 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.ComputeOptimizer.Types.ECSServiceUtilizationMetric
-- 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.ComputeOptimizer.Types.ECSServiceUtilizationMetric where

import Amazonka.ComputeOptimizer.Types.ECSServiceMetricName
import Amazonka.ComputeOptimizer.Types.ECSServiceMetricStatistic
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

-- | Describes the utilization metric of an Amazon ECS service.
--
-- To determine the performance difference between your current ECS service
-- and the recommended option, compare the utilization metric data of your
-- service against its projected utilization metric data.
--
-- /See:/ 'newECSServiceUtilizationMetric' smart constructor.
data ECSServiceUtilizationMetric = ECSServiceUtilizationMetric'
  { -- | The name of the utilization metric.
    --
    -- The following utilization metrics are available:
    --
    -- -   @Cpu@ — The amount of CPU units that are used in the service.
    --
    -- -   @Memory@ — The amount of memory that is used in the service.
    ECSServiceUtilizationMetric -> Maybe ECSServiceMetricName
name :: Prelude.Maybe ECSServiceMetricName,
    -- | The statistic of the utilization metric.
    --
    -- The Compute Optimizer API, Command Line Interface (CLI), and SDKs return
    -- utilization metrics using only the @Maximum@ statistic, which is the
    -- highest value observed during the specified period.
    --
    -- The Compute Optimizer console displays graphs for some utilization
    -- metrics using the @Average@ statistic, which is the value of @Sum@ \/
    -- @SampleCount@ during the specified period. For more information, see
    -- <https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html Viewing resource recommendations>
    -- in the /Compute Optimizer User Guide/. You can also get averaged
    -- utilization metric data for your resources using Amazon CloudWatch. For
    -- more information, see the
    -- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html Amazon CloudWatch User Guide>.
    ECSServiceUtilizationMetric -> Maybe ECSServiceMetricStatistic
statistic :: Prelude.Maybe ECSServiceMetricStatistic,
    -- | The value of the utilization metric.
    ECSServiceUtilizationMetric -> Maybe Double
value :: Prelude.Maybe Prelude.Double
  }
  deriving (ECSServiceUtilizationMetric -> ECSServiceUtilizationMetric -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ECSServiceUtilizationMetric -> ECSServiceUtilizationMetric -> Bool
$c/= :: ECSServiceUtilizationMetric -> ECSServiceUtilizationMetric -> Bool
== :: ECSServiceUtilizationMetric -> ECSServiceUtilizationMetric -> Bool
$c== :: ECSServiceUtilizationMetric -> ECSServiceUtilizationMetric -> Bool
Prelude.Eq, ReadPrec [ECSServiceUtilizationMetric]
ReadPrec ECSServiceUtilizationMetric
Int -> ReadS ECSServiceUtilizationMetric
ReadS [ECSServiceUtilizationMetric]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ECSServiceUtilizationMetric]
$creadListPrec :: ReadPrec [ECSServiceUtilizationMetric]
readPrec :: ReadPrec ECSServiceUtilizationMetric
$creadPrec :: ReadPrec ECSServiceUtilizationMetric
readList :: ReadS [ECSServiceUtilizationMetric]
$creadList :: ReadS [ECSServiceUtilizationMetric]
readsPrec :: Int -> ReadS ECSServiceUtilizationMetric
$creadsPrec :: Int -> ReadS ECSServiceUtilizationMetric
Prelude.Read, Int -> ECSServiceUtilizationMetric -> ShowS
[ECSServiceUtilizationMetric] -> ShowS
ECSServiceUtilizationMetric -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ECSServiceUtilizationMetric] -> ShowS
$cshowList :: [ECSServiceUtilizationMetric] -> ShowS
show :: ECSServiceUtilizationMetric -> String
$cshow :: ECSServiceUtilizationMetric -> String
showsPrec :: Int -> ECSServiceUtilizationMetric -> ShowS
$cshowsPrec :: Int -> ECSServiceUtilizationMetric -> ShowS
Prelude.Show, forall x.
Rep ECSServiceUtilizationMetric x -> ECSServiceUtilizationMetric
forall x.
ECSServiceUtilizationMetric -> Rep ECSServiceUtilizationMetric x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ECSServiceUtilizationMetric x -> ECSServiceUtilizationMetric
$cfrom :: forall x.
ECSServiceUtilizationMetric -> Rep ECSServiceUtilizationMetric x
Prelude.Generic)

-- |
-- Create a value of 'ECSServiceUtilizationMetric' 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:
--
-- 'name', 'eCSServiceUtilizationMetric_name' - The name of the utilization metric.
--
-- The following utilization metrics are available:
--
-- -   @Cpu@ — The amount of CPU units that are used in the service.
--
-- -   @Memory@ — The amount of memory that is used in the service.
--
-- 'statistic', 'eCSServiceUtilizationMetric_statistic' - The statistic of the utilization metric.
--
-- The Compute Optimizer API, Command Line Interface (CLI), and SDKs return
-- utilization metrics using only the @Maximum@ statistic, which is the
-- highest value observed during the specified period.
--
-- The Compute Optimizer console displays graphs for some utilization
-- metrics using the @Average@ statistic, which is the value of @Sum@ \/
-- @SampleCount@ during the specified period. For more information, see
-- <https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html Viewing resource recommendations>
-- in the /Compute Optimizer User Guide/. You can also get averaged
-- utilization metric data for your resources using Amazon CloudWatch. For
-- more information, see the
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html Amazon CloudWatch User Guide>.
--
-- 'value', 'eCSServiceUtilizationMetric_value' - The value of the utilization metric.
newECSServiceUtilizationMetric ::
  ECSServiceUtilizationMetric
newECSServiceUtilizationMetric :: ECSServiceUtilizationMetric
newECSServiceUtilizationMetric =
  ECSServiceUtilizationMetric'
    { $sel:name:ECSServiceUtilizationMetric' :: Maybe ECSServiceMetricName
name =
        forall a. Maybe a
Prelude.Nothing,
      $sel:statistic:ECSServiceUtilizationMetric' :: Maybe ECSServiceMetricStatistic
statistic = forall a. Maybe a
Prelude.Nothing,
      $sel:value:ECSServiceUtilizationMetric' :: Maybe Double
value = forall a. Maybe a
Prelude.Nothing
    }

-- | The name of the utilization metric.
--
-- The following utilization metrics are available:
--
-- -   @Cpu@ — The amount of CPU units that are used in the service.
--
-- -   @Memory@ — The amount of memory that is used in the service.
eCSServiceUtilizationMetric_name :: Lens.Lens' ECSServiceUtilizationMetric (Prelude.Maybe ECSServiceMetricName)
eCSServiceUtilizationMetric_name :: Lens' ECSServiceUtilizationMetric (Maybe ECSServiceMetricName)
eCSServiceUtilizationMetric_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ECSServiceUtilizationMetric' {Maybe ECSServiceMetricName
name :: Maybe ECSServiceMetricName
$sel:name:ECSServiceUtilizationMetric' :: ECSServiceUtilizationMetric -> Maybe ECSServiceMetricName
name} -> Maybe ECSServiceMetricName
name) (\s :: ECSServiceUtilizationMetric
s@ECSServiceUtilizationMetric' {} Maybe ECSServiceMetricName
a -> ECSServiceUtilizationMetric
s {$sel:name:ECSServiceUtilizationMetric' :: Maybe ECSServiceMetricName
name = Maybe ECSServiceMetricName
a} :: ECSServiceUtilizationMetric)

-- | The statistic of the utilization metric.
--
-- The Compute Optimizer API, Command Line Interface (CLI), and SDKs return
-- utilization metrics using only the @Maximum@ statistic, which is the
-- highest value observed during the specified period.
--
-- The Compute Optimizer console displays graphs for some utilization
-- metrics using the @Average@ statistic, which is the value of @Sum@ \/
-- @SampleCount@ during the specified period. For more information, see
-- <https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html Viewing resource recommendations>
-- in the /Compute Optimizer User Guide/. You can also get averaged
-- utilization metric data for your resources using Amazon CloudWatch. For
-- more information, see the
-- <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html Amazon CloudWatch User Guide>.
eCSServiceUtilizationMetric_statistic :: Lens.Lens' ECSServiceUtilizationMetric (Prelude.Maybe ECSServiceMetricStatistic)
eCSServiceUtilizationMetric_statistic :: Lens' ECSServiceUtilizationMetric (Maybe ECSServiceMetricStatistic)
eCSServiceUtilizationMetric_statistic = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ECSServiceUtilizationMetric' {Maybe ECSServiceMetricStatistic
statistic :: Maybe ECSServiceMetricStatistic
$sel:statistic:ECSServiceUtilizationMetric' :: ECSServiceUtilizationMetric -> Maybe ECSServiceMetricStatistic
statistic} -> Maybe ECSServiceMetricStatistic
statistic) (\s :: ECSServiceUtilizationMetric
s@ECSServiceUtilizationMetric' {} Maybe ECSServiceMetricStatistic
a -> ECSServiceUtilizationMetric
s {$sel:statistic:ECSServiceUtilizationMetric' :: Maybe ECSServiceMetricStatistic
statistic = Maybe ECSServiceMetricStatistic
a} :: ECSServiceUtilizationMetric)

-- | The value of the utilization metric.
eCSServiceUtilizationMetric_value :: Lens.Lens' ECSServiceUtilizationMetric (Prelude.Maybe Prelude.Double)
eCSServiceUtilizationMetric_value :: Lens' ECSServiceUtilizationMetric (Maybe Double)
eCSServiceUtilizationMetric_value = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ECSServiceUtilizationMetric' {Maybe Double
value :: Maybe Double
$sel:value:ECSServiceUtilizationMetric' :: ECSServiceUtilizationMetric -> Maybe Double
value} -> Maybe Double
value) (\s :: ECSServiceUtilizationMetric
s@ECSServiceUtilizationMetric' {} Maybe Double
a -> ECSServiceUtilizationMetric
s {$sel:value:ECSServiceUtilizationMetric' :: Maybe Double
value = Maybe Double
a} :: ECSServiceUtilizationMetric)

instance Data.FromJSON ECSServiceUtilizationMetric where
  parseJSON :: Value -> Parser ECSServiceUtilizationMetric
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ECSServiceUtilizationMetric"
      ( \Object
x ->
          Maybe ECSServiceMetricName
-> Maybe ECSServiceMetricStatistic
-> Maybe Double
-> ECSServiceUtilizationMetric
ECSServiceUtilizationMetric'
            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
"name")
            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
"statistic")
            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
"value")
      )

instance Prelude.Hashable ECSServiceUtilizationMetric where
  hashWithSalt :: Int -> ECSServiceUtilizationMetric -> Int
hashWithSalt Int
_salt ECSServiceUtilizationMetric' {Maybe Double
Maybe ECSServiceMetricName
Maybe ECSServiceMetricStatistic
value :: Maybe Double
statistic :: Maybe ECSServiceMetricStatistic
name :: Maybe ECSServiceMetricName
$sel:value:ECSServiceUtilizationMetric' :: ECSServiceUtilizationMetric -> Maybe Double
$sel:statistic:ECSServiceUtilizationMetric' :: ECSServiceUtilizationMetric -> Maybe ECSServiceMetricStatistic
$sel:name:ECSServiceUtilizationMetric' :: ECSServiceUtilizationMetric -> Maybe ECSServiceMetricName
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ECSServiceMetricName
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ECSServiceMetricStatistic
statistic
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Double
value

instance Prelude.NFData ECSServiceUtilizationMetric where
  rnf :: ECSServiceUtilizationMetric -> ()
rnf ECSServiceUtilizationMetric' {Maybe Double
Maybe ECSServiceMetricName
Maybe ECSServiceMetricStatistic
value :: Maybe Double
statistic :: Maybe ECSServiceMetricStatistic
name :: Maybe ECSServiceMetricName
$sel:value:ECSServiceUtilizationMetric' :: ECSServiceUtilizationMetric -> Maybe Double
$sel:statistic:ECSServiceUtilizationMetric' :: ECSServiceUtilizationMetric -> Maybe ECSServiceMetricStatistic
$sel:name:ECSServiceUtilizationMetric' :: ECSServiceUtilizationMetric -> Maybe ECSServiceMetricName
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ECSServiceMetricName
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ECSServiceMetricStatistic
statistic
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Double
value