{-# 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.DynamoDB.Types.AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-- 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.DynamoDB.Types.AutoScalingTargetTrackingScalingPolicyConfigurationDescription where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.DynamoDB.Types.AttributeValue
import Amazonka.DynamoDB.Types.WriteRequest
import qualified Amazonka.Prelude as Prelude

-- | Represents the properties of a target tracking scaling policy.
--
-- /See:/ 'newAutoScalingTargetTrackingScalingPolicyConfigurationDescription' smart constructor.
data AutoScalingTargetTrackingScalingPolicyConfigurationDescription = AutoScalingTargetTrackingScalingPolicyConfigurationDescription'
  { -- | Indicates whether scale in by the target tracking policy is disabled. If
    -- the value is true, scale in is disabled and the target tracking policy
    -- won\'t remove capacity from the scalable resource. Otherwise, scale in
    -- is enabled and the target tracking policy can remove capacity from the
    -- scalable resource. The default value is false.
    AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Bool
disableScaleIn :: Prelude.Maybe Prelude.Bool,
    -- | The amount of time, in seconds, after a scale in activity completes
    -- before another scale in activity can start. The cooldown period is used
    -- to block subsequent scale in requests until it has expired. You should
    -- scale in conservatively to protect your application\'s availability.
    -- However, if another alarm triggers a scale out policy during the
    -- cooldown period after a scale-in, application auto scaling scales out
    -- your scalable target immediately.
    AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Int
scaleInCooldown :: Prelude.Maybe Prelude.Int,
    -- | The amount of time, in seconds, after a scale out activity completes
    -- before another scale out activity can start. While the cooldown period
    -- is in effect, the capacity that has been added by the previous scale out
    -- event that initiated the cooldown is calculated as part of the desired
    -- capacity for the next scale out. You should continuously (but not
    -- excessively) scale out.
    AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Int
scaleOutCooldown :: Prelude.Maybe Prelude.Int,
    -- | The target value for the metric. The range is 8.515920e-109 to
    -- 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
    AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Double
targetValue :: Prelude.Double
  }
  deriving (AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Bool
$c/= :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Bool
== :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Bool
$c== :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Bool
Prelude.Eq, ReadPrec
  [AutoScalingTargetTrackingScalingPolicyConfigurationDescription]
ReadPrec
  AutoScalingTargetTrackingScalingPolicyConfigurationDescription
Int
-> ReadS
     AutoScalingTargetTrackingScalingPolicyConfigurationDescription
ReadS
  [AutoScalingTargetTrackingScalingPolicyConfigurationDescription]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec
  [AutoScalingTargetTrackingScalingPolicyConfigurationDescription]
$creadListPrec :: ReadPrec
  [AutoScalingTargetTrackingScalingPolicyConfigurationDescription]
readPrec :: ReadPrec
  AutoScalingTargetTrackingScalingPolicyConfigurationDescription
$creadPrec :: ReadPrec
  AutoScalingTargetTrackingScalingPolicyConfigurationDescription
readList :: ReadS
  [AutoScalingTargetTrackingScalingPolicyConfigurationDescription]
$creadList :: ReadS
  [AutoScalingTargetTrackingScalingPolicyConfigurationDescription]
readsPrec :: Int
-> ReadS
     AutoScalingTargetTrackingScalingPolicyConfigurationDescription
$creadsPrec :: Int
-> ReadS
     AutoScalingTargetTrackingScalingPolicyConfigurationDescription
Prelude.Read, Int
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> ShowS
[AutoScalingTargetTrackingScalingPolicyConfigurationDescription]
-> ShowS
AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AutoScalingTargetTrackingScalingPolicyConfigurationDescription]
-> ShowS
$cshowList :: [AutoScalingTargetTrackingScalingPolicyConfigurationDescription]
-> ShowS
show :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> String
$cshow :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> String
showsPrec :: Int
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> ShowS
$cshowsPrec :: Int
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> ShowS
Prelude.Show, forall x.
Rep
  AutoScalingTargetTrackingScalingPolicyConfigurationDescription x
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
forall x.
AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Rep
     AutoScalingTargetTrackingScalingPolicyConfigurationDescription x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep
  AutoScalingTargetTrackingScalingPolicyConfigurationDescription x
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
$cfrom :: forall x.
AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Rep
     AutoScalingTargetTrackingScalingPolicyConfigurationDescription x
Prelude.Generic)

-- |
-- Create a value of 'AutoScalingTargetTrackingScalingPolicyConfigurationDescription' 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:
--
-- 'disableScaleIn', 'autoScalingTargetTrackingScalingPolicyConfigurationDescription_disableScaleIn' - Indicates whether scale in by the target tracking policy is disabled. If
-- the value is true, scale in is disabled and the target tracking policy
-- won\'t remove capacity from the scalable resource. Otherwise, scale in
-- is enabled and the target tracking policy can remove capacity from the
-- scalable resource. The default value is false.
--
-- 'scaleInCooldown', 'autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleInCooldown' - The amount of time, in seconds, after a scale in activity completes
-- before another scale in activity can start. The cooldown period is used
-- to block subsequent scale in requests until it has expired. You should
-- scale in conservatively to protect your application\'s availability.
-- However, if another alarm triggers a scale out policy during the
-- cooldown period after a scale-in, application auto scaling scales out
-- your scalable target immediately.
--
-- 'scaleOutCooldown', 'autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleOutCooldown' - The amount of time, in seconds, after a scale out activity completes
-- before another scale out activity can start. While the cooldown period
-- is in effect, the capacity that has been added by the previous scale out
-- event that initiated the cooldown is calculated as part of the desired
-- capacity for the next scale out. You should continuously (but not
-- excessively) scale out.
--
-- 'targetValue', 'autoScalingTargetTrackingScalingPolicyConfigurationDescription_targetValue' - The target value for the metric. The range is 8.515920e-109 to
-- 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
newAutoScalingTargetTrackingScalingPolicyConfigurationDescription ::
  -- | 'targetValue'
  Prelude.Double ->
  AutoScalingTargetTrackingScalingPolicyConfigurationDescription
newAutoScalingTargetTrackingScalingPolicyConfigurationDescription :: Double
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
newAutoScalingTargetTrackingScalingPolicyConfigurationDescription
  Double
pTargetValue_ =
    AutoScalingTargetTrackingScalingPolicyConfigurationDescription'
      { $sel:disableScaleIn:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: Maybe Bool
disableScaleIn =
          forall a. Maybe a
Prelude.Nothing,
        $sel:scaleInCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: Maybe Int
scaleInCooldown =
          forall a. Maybe a
Prelude.Nothing,
        $sel:scaleOutCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: Maybe Int
scaleOutCooldown =
          forall a. Maybe a
Prelude.Nothing,
        $sel:targetValue:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: Double
targetValue =
          Double
pTargetValue_
      }

-- | Indicates whether scale in by the target tracking policy is disabled. If
-- the value is true, scale in is disabled and the target tracking policy
-- won\'t remove capacity from the scalable resource. Otherwise, scale in
-- is enabled and the target tracking policy can remove capacity from the
-- scalable resource. The default value is false.
autoScalingTargetTrackingScalingPolicyConfigurationDescription_disableScaleIn :: Lens.Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription (Prelude.Maybe Prelude.Bool)
autoScalingTargetTrackingScalingPolicyConfigurationDescription_disableScaleIn :: Lens'
  AutoScalingTargetTrackingScalingPolicyConfigurationDescription
  (Maybe Bool)
autoScalingTargetTrackingScalingPolicyConfigurationDescription_disableScaleIn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AutoScalingTargetTrackingScalingPolicyConfigurationDescription' {Maybe Bool
disableScaleIn :: Maybe Bool
$sel:disableScaleIn:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Bool
disableScaleIn} -> Maybe Bool
disableScaleIn) (\s :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
s@AutoScalingTargetTrackingScalingPolicyConfigurationDescription' {} Maybe Bool
a -> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
s {$sel:disableScaleIn:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: Maybe Bool
disableScaleIn = Maybe Bool
a} :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription)

-- | The amount of time, in seconds, after a scale in activity completes
-- before another scale in activity can start. The cooldown period is used
-- to block subsequent scale in requests until it has expired. You should
-- scale in conservatively to protect your application\'s availability.
-- However, if another alarm triggers a scale out policy during the
-- cooldown period after a scale-in, application auto scaling scales out
-- your scalable target immediately.
autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleInCooldown :: Lens.Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription (Prelude.Maybe Prelude.Int)
autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleInCooldown :: Lens'
  AutoScalingTargetTrackingScalingPolicyConfigurationDescription
  (Maybe Int)
autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleInCooldown = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AutoScalingTargetTrackingScalingPolicyConfigurationDescription' {Maybe Int
scaleInCooldown :: Maybe Int
$sel:scaleInCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Int
scaleInCooldown} -> Maybe Int
scaleInCooldown) (\s :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
s@AutoScalingTargetTrackingScalingPolicyConfigurationDescription' {} Maybe Int
a -> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
s {$sel:scaleInCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: Maybe Int
scaleInCooldown = Maybe Int
a} :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription)

-- | The amount of time, in seconds, after a scale out activity completes
-- before another scale out activity can start. While the cooldown period
-- is in effect, the capacity that has been added by the previous scale out
-- event that initiated the cooldown is calculated as part of the desired
-- capacity for the next scale out. You should continuously (but not
-- excessively) scale out.
autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleOutCooldown :: Lens.Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription (Prelude.Maybe Prelude.Int)
autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleOutCooldown :: Lens'
  AutoScalingTargetTrackingScalingPolicyConfigurationDescription
  (Maybe Int)
autoScalingTargetTrackingScalingPolicyConfigurationDescription_scaleOutCooldown = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AutoScalingTargetTrackingScalingPolicyConfigurationDescription' {Maybe Int
scaleOutCooldown :: Maybe Int
$sel:scaleOutCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Int
scaleOutCooldown} -> Maybe Int
scaleOutCooldown) (\s :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
s@AutoScalingTargetTrackingScalingPolicyConfigurationDescription' {} Maybe Int
a -> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
s {$sel:scaleOutCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: Maybe Int
scaleOutCooldown = Maybe Int
a} :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription)

-- | The target value for the metric. The range is 8.515920e-109 to
-- 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
autoScalingTargetTrackingScalingPolicyConfigurationDescription_targetValue :: Lens.Lens' AutoScalingTargetTrackingScalingPolicyConfigurationDescription Prelude.Double
autoScalingTargetTrackingScalingPolicyConfigurationDescription_targetValue :: Lens'
  AutoScalingTargetTrackingScalingPolicyConfigurationDescription
  Double
autoScalingTargetTrackingScalingPolicyConfigurationDescription_targetValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AutoScalingTargetTrackingScalingPolicyConfigurationDescription' {Double
targetValue :: Double
$sel:targetValue:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Double
targetValue} -> Double
targetValue) (\s :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
s@AutoScalingTargetTrackingScalingPolicyConfigurationDescription' {} Double
a -> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
s {$sel:targetValue:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: Double
targetValue = Double
a} :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription)

instance
  Data.FromJSON
    AutoScalingTargetTrackingScalingPolicyConfigurationDescription
  where
  parseJSON :: Value
-> Parser
     AutoScalingTargetTrackingScalingPolicyConfigurationDescription
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"AutoScalingTargetTrackingScalingPolicyConfigurationDescription"
      ( \Object
x ->
          Maybe Bool
-> Maybe Int
-> Maybe Int
-> Double
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
AutoScalingTargetTrackingScalingPolicyConfigurationDescription'
            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
"DisableScaleIn")
            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
"ScaleInCooldown")
            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
"ScaleOutCooldown")
            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
"TargetValue")
      )

instance
  Prelude.Hashable
    AutoScalingTargetTrackingScalingPolicyConfigurationDescription
  where
  hashWithSalt :: Int
-> AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Int
hashWithSalt
    Int
_salt
    AutoScalingTargetTrackingScalingPolicyConfigurationDescription' {Double
Maybe Bool
Maybe Int
targetValue :: Double
scaleOutCooldown :: Maybe Int
scaleInCooldown :: Maybe Int
disableScaleIn :: Maybe Bool
$sel:targetValue:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Double
$sel:scaleOutCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Int
$sel:scaleInCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Int
$sel:disableScaleIn:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Bool
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
disableScaleIn
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
scaleInCooldown
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
scaleOutCooldown
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Double
targetValue

instance
  Prelude.NFData
    AutoScalingTargetTrackingScalingPolicyConfigurationDescription
  where
  rnf :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> ()
rnf
    AutoScalingTargetTrackingScalingPolicyConfigurationDescription' {Double
Maybe Bool
Maybe Int
targetValue :: Double
scaleOutCooldown :: Maybe Int
scaleInCooldown :: Maybe Int
disableScaleIn :: Maybe Bool
$sel:targetValue:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Double
$sel:scaleOutCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Int
$sel:scaleInCooldown:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Int
$sel:disableScaleIn:AutoScalingTargetTrackingScalingPolicyConfigurationDescription' :: AutoScalingTargetTrackingScalingPolicyConfigurationDescription
-> Maybe Bool
..} =
      forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
disableScaleIn
        seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
scaleInCooldown
        seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
scaleOutCooldown
        seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Double
targetValue