{-# 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.EBSUtilizationMetric
-- 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.EBSUtilizationMetric where

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

-- | Describes a utilization metric of an Amazon Elastic Block Store (Amazon
-- EBS) volume.
--
-- Compare the utilization metric data of your resource against its
-- projected utilization metric data to determine the performance
-- difference between your current resource and the recommended option.
--
-- /See:/ 'newEBSUtilizationMetric' smart constructor.
data EBSUtilizationMetric = EBSUtilizationMetric'
  { -- | The name of the utilization metric.
    --
    -- The following utilization metrics are available:
    --
    -- -   @VolumeReadOpsPerSecond@ - The completed read operations per second
    --     from the volume in a specified period of time.
    --
    --     Unit: Count
    --
    -- -   @VolumeWriteOpsPerSecond@ - The completed write operations per
    --     second to the volume in a specified period of time.
    --
    --     Unit: Count
    --
    -- -   @VolumeReadBytesPerSecond@ - The bytes read per second from the
    --     volume in a specified period of time.
    --
    --     Unit: Bytes
    --
    -- -   @VolumeWriteBytesPerSecond@ - The bytes written to the volume in a
    --     specified period of time.
    --
    --     Unit: Bytes
    EBSUtilizationMetric -> Maybe EBSMetricName
name :: Prelude.Maybe EBSMetricName,
    -- | 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>.
    EBSUtilizationMetric -> Maybe MetricStatistic
statistic :: Prelude.Maybe MetricStatistic,
    -- | The value of the utilization metric.
    EBSUtilizationMetric -> Maybe Double
value :: Prelude.Maybe Prelude.Double
  }
  deriving (EBSUtilizationMetric -> EBSUtilizationMetric -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EBSUtilizationMetric -> EBSUtilizationMetric -> Bool
$c/= :: EBSUtilizationMetric -> EBSUtilizationMetric -> Bool
== :: EBSUtilizationMetric -> EBSUtilizationMetric -> Bool
$c== :: EBSUtilizationMetric -> EBSUtilizationMetric -> Bool
Prelude.Eq, ReadPrec [EBSUtilizationMetric]
ReadPrec EBSUtilizationMetric
Int -> ReadS EBSUtilizationMetric
ReadS [EBSUtilizationMetric]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EBSUtilizationMetric]
$creadListPrec :: ReadPrec [EBSUtilizationMetric]
readPrec :: ReadPrec EBSUtilizationMetric
$creadPrec :: ReadPrec EBSUtilizationMetric
readList :: ReadS [EBSUtilizationMetric]
$creadList :: ReadS [EBSUtilizationMetric]
readsPrec :: Int -> ReadS EBSUtilizationMetric
$creadsPrec :: Int -> ReadS EBSUtilizationMetric
Prelude.Read, Int -> EBSUtilizationMetric -> ShowS
[EBSUtilizationMetric] -> ShowS
EBSUtilizationMetric -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EBSUtilizationMetric] -> ShowS
$cshowList :: [EBSUtilizationMetric] -> ShowS
show :: EBSUtilizationMetric -> String
$cshow :: EBSUtilizationMetric -> String
showsPrec :: Int -> EBSUtilizationMetric -> ShowS
$cshowsPrec :: Int -> EBSUtilizationMetric -> ShowS
Prelude.Show, forall x. Rep EBSUtilizationMetric x -> EBSUtilizationMetric
forall x. EBSUtilizationMetric -> Rep EBSUtilizationMetric x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep EBSUtilizationMetric x -> EBSUtilizationMetric
$cfrom :: forall x. EBSUtilizationMetric -> Rep EBSUtilizationMetric x
Prelude.Generic)

-- |
-- Create a value of 'EBSUtilizationMetric' 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', 'eBSUtilizationMetric_name' - The name of the utilization metric.
--
-- The following utilization metrics are available:
--
-- -   @VolumeReadOpsPerSecond@ - The completed read operations per second
--     from the volume in a specified period of time.
--
--     Unit: Count
--
-- -   @VolumeWriteOpsPerSecond@ - The completed write operations per
--     second to the volume in a specified period of time.
--
--     Unit: Count
--
-- -   @VolumeReadBytesPerSecond@ - The bytes read per second from the
--     volume in a specified period of time.
--
--     Unit: Bytes
--
-- -   @VolumeWriteBytesPerSecond@ - The bytes written to the volume in a
--     specified period of time.
--
--     Unit: Bytes
--
-- 'statistic', 'eBSUtilizationMetric_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', 'eBSUtilizationMetric_value' - The value of the utilization metric.
newEBSUtilizationMetric ::
  EBSUtilizationMetric
newEBSUtilizationMetric :: EBSUtilizationMetric
newEBSUtilizationMetric =
  EBSUtilizationMetric'
    { $sel:name:EBSUtilizationMetric' :: Maybe EBSMetricName
name = forall a. Maybe a
Prelude.Nothing,
      $sel:statistic:EBSUtilizationMetric' :: Maybe MetricStatistic
statistic = forall a. Maybe a
Prelude.Nothing,
      $sel:value:EBSUtilizationMetric' :: Maybe Double
value = forall a. Maybe a
Prelude.Nothing
    }

-- | The name of the utilization metric.
--
-- The following utilization metrics are available:
--
-- -   @VolumeReadOpsPerSecond@ - The completed read operations per second
--     from the volume in a specified period of time.
--
--     Unit: Count
--
-- -   @VolumeWriteOpsPerSecond@ - The completed write operations per
--     second to the volume in a specified period of time.
--
--     Unit: Count
--
-- -   @VolumeReadBytesPerSecond@ - The bytes read per second from the
--     volume in a specified period of time.
--
--     Unit: Bytes
--
-- -   @VolumeWriteBytesPerSecond@ - The bytes written to the volume in a
--     specified period of time.
--
--     Unit: Bytes
eBSUtilizationMetric_name :: Lens.Lens' EBSUtilizationMetric (Prelude.Maybe EBSMetricName)
eBSUtilizationMetric_name :: Lens' EBSUtilizationMetric (Maybe EBSMetricName)
eBSUtilizationMetric_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EBSUtilizationMetric' {Maybe EBSMetricName
name :: Maybe EBSMetricName
$sel:name:EBSUtilizationMetric' :: EBSUtilizationMetric -> Maybe EBSMetricName
name} -> Maybe EBSMetricName
name) (\s :: EBSUtilizationMetric
s@EBSUtilizationMetric' {} Maybe EBSMetricName
a -> EBSUtilizationMetric
s {$sel:name:EBSUtilizationMetric' :: Maybe EBSMetricName
name = Maybe EBSMetricName
a} :: EBSUtilizationMetric)

-- | 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>.
eBSUtilizationMetric_statistic :: Lens.Lens' EBSUtilizationMetric (Prelude.Maybe MetricStatistic)
eBSUtilizationMetric_statistic :: Lens' EBSUtilizationMetric (Maybe MetricStatistic)
eBSUtilizationMetric_statistic = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EBSUtilizationMetric' {Maybe MetricStatistic
statistic :: Maybe MetricStatistic
$sel:statistic:EBSUtilizationMetric' :: EBSUtilizationMetric -> Maybe MetricStatistic
statistic} -> Maybe MetricStatistic
statistic) (\s :: EBSUtilizationMetric
s@EBSUtilizationMetric' {} Maybe MetricStatistic
a -> EBSUtilizationMetric
s {$sel:statistic:EBSUtilizationMetric' :: Maybe MetricStatistic
statistic = Maybe MetricStatistic
a} :: EBSUtilizationMetric)

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

instance Data.FromJSON EBSUtilizationMetric where
  parseJSON :: Value -> Parser EBSUtilizationMetric
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"EBSUtilizationMetric"
      ( \Object
x ->
          Maybe EBSMetricName
-> Maybe MetricStatistic -> Maybe Double -> EBSUtilizationMetric
EBSUtilizationMetric'
            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 EBSUtilizationMetric where
  hashWithSalt :: Int -> EBSUtilizationMetric -> Int
hashWithSalt Int
_salt EBSUtilizationMetric' {Maybe Double
Maybe EBSMetricName
Maybe MetricStatistic
value :: Maybe Double
statistic :: Maybe MetricStatistic
name :: Maybe EBSMetricName
$sel:value:EBSUtilizationMetric' :: EBSUtilizationMetric -> Maybe Double
$sel:statistic:EBSUtilizationMetric' :: EBSUtilizationMetric -> Maybe MetricStatistic
$sel:name:EBSUtilizationMetric' :: EBSUtilizationMetric -> Maybe EBSMetricName
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe EBSMetricName
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe MetricStatistic
statistic
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Double
value

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