{-# 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.AutoScaling.Types.TargetTrackingConfiguration
-- 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.AutoScaling.Types.TargetTrackingConfiguration where

import Amazonka.AutoScaling.Types.CustomizedMetricSpecification
import Amazonka.AutoScaling.Types.PredefinedMetricSpecification
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 target tracking scaling policy configuration to use with
-- Amazon EC2 Auto Scaling.
--
-- /See:/ 'newTargetTrackingConfiguration' smart constructor.
data TargetTrackingConfiguration = TargetTrackingConfiguration'
  { -- | A customized metric. You must specify either a predefined metric or a
    -- customized metric.
    TargetTrackingConfiguration -> Maybe CustomizedMetricSpecification
customizedMetricSpecification :: Prelude.Maybe CustomizedMetricSpecification,
    -- | Indicates whether scaling in by the target tracking scaling policy is
    -- disabled. If scaling in is disabled, the target tracking scaling policy
    -- doesn\'t remove instances from the Auto Scaling group. Otherwise, the
    -- target tracking scaling policy can remove instances from the Auto
    -- Scaling group. The default is @false@.
    TargetTrackingConfiguration -> Maybe Bool
disableScaleIn :: Prelude.Maybe Prelude.Bool,
    -- | A predefined metric. You must specify either a predefined metric or a
    -- customized metric.
    TargetTrackingConfiguration -> Maybe PredefinedMetricSpecification
predefinedMetricSpecification :: Prelude.Maybe PredefinedMetricSpecification,
    -- | The target value for the metric.
    --
    -- Some metrics are based on a count instead of a percentage, such as the
    -- request count for an Application Load Balancer or the number of messages
    -- in an SQS queue. If the scaling policy specifies one of these metrics,
    -- specify the target utilization as the optimal average request or message
    -- count per instance during any one-minute interval.
    TargetTrackingConfiguration -> Double
targetValue :: Prelude.Double
  }
  deriving (TargetTrackingConfiguration -> TargetTrackingConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TargetTrackingConfiguration -> TargetTrackingConfiguration -> Bool
$c/= :: TargetTrackingConfiguration -> TargetTrackingConfiguration -> Bool
== :: TargetTrackingConfiguration -> TargetTrackingConfiguration -> Bool
$c== :: TargetTrackingConfiguration -> TargetTrackingConfiguration -> Bool
Prelude.Eq, ReadPrec [TargetTrackingConfiguration]
ReadPrec TargetTrackingConfiguration
Int -> ReadS TargetTrackingConfiguration
ReadS [TargetTrackingConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TargetTrackingConfiguration]
$creadListPrec :: ReadPrec [TargetTrackingConfiguration]
readPrec :: ReadPrec TargetTrackingConfiguration
$creadPrec :: ReadPrec TargetTrackingConfiguration
readList :: ReadS [TargetTrackingConfiguration]
$creadList :: ReadS [TargetTrackingConfiguration]
readsPrec :: Int -> ReadS TargetTrackingConfiguration
$creadsPrec :: Int -> ReadS TargetTrackingConfiguration
Prelude.Read, Int -> TargetTrackingConfiguration -> ShowS
[TargetTrackingConfiguration] -> ShowS
TargetTrackingConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TargetTrackingConfiguration] -> ShowS
$cshowList :: [TargetTrackingConfiguration] -> ShowS
show :: TargetTrackingConfiguration -> String
$cshow :: TargetTrackingConfiguration -> String
showsPrec :: Int -> TargetTrackingConfiguration -> ShowS
$cshowsPrec :: Int -> TargetTrackingConfiguration -> ShowS
Prelude.Show, forall x.
Rep TargetTrackingConfiguration x -> TargetTrackingConfiguration
forall x.
TargetTrackingConfiguration -> Rep TargetTrackingConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep TargetTrackingConfiguration x -> TargetTrackingConfiguration
$cfrom :: forall x.
TargetTrackingConfiguration -> Rep TargetTrackingConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'TargetTrackingConfiguration' 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:
--
-- 'customizedMetricSpecification', 'targetTrackingConfiguration_customizedMetricSpecification' - A customized metric. You must specify either a predefined metric or a
-- customized metric.
--
-- 'disableScaleIn', 'targetTrackingConfiguration_disableScaleIn' - Indicates whether scaling in by the target tracking scaling policy is
-- disabled. If scaling in is disabled, the target tracking scaling policy
-- doesn\'t remove instances from the Auto Scaling group. Otherwise, the
-- target tracking scaling policy can remove instances from the Auto
-- Scaling group. The default is @false@.
--
-- 'predefinedMetricSpecification', 'targetTrackingConfiguration_predefinedMetricSpecification' - A predefined metric. You must specify either a predefined metric or a
-- customized metric.
--
-- 'targetValue', 'targetTrackingConfiguration_targetValue' - The target value for the metric.
--
-- Some metrics are based on a count instead of a percentage, such as the
-- request count for an Application Load Balancer or the number of messages
-- in an SQS queue. If the scaling policy specifies one of these metrics,
-- specify the target utilization as the optimal average request or message
-- count per instance during any one-minute interval.
newTargetTrackingConfiguration ::
  -- | 'targetValue'
  Prelude.Double ->
  TargetTrackingConfiguration
newTargetTrackingConfiguration :: Double -> TargetTrackingConfiguration
newTargetTrackingConfiguration Double
pTargetValue_ =
  TargetTrackingConfiguration'
    { $sel:customizedMetricSpecification:TargetTrackingConfiguration' :: Maybe CustomizedMetricSpecification
customizedMetricSpecification =
        forall a. Maybe a
Prelude.Nothing,
      $sel:disableScaleIn:TargetTrackingConfiguration' :: Maybe Bool
disableScaleIn = forall a. Maybe a
Prelude.Nothing,
      $sel:predefinedMetricSpecification:TargetTrackingConfiguration' :: Maybe PredefinedMetricSpecification
predefinedMetricSpecification =
        forall a. Maybe a
Prelude.Nothing,
      $sel:targetValue:TargetTrackingConfiguration' :: Double
targetValue = Double
pTargetValue_
    }

-- | A customized metric. You must specify either a predefined metric or a
-- customized metric.
targetTrackingConfiguration_customizedMetricSpecification :: Lens.Lens' TargetTrackingConfiguration (Prelude.Maybe CustomizedMetricSpecification)
targetTrackingConfiguration_customizedMetricSpecification :: Lens'
  TargetTrackingConfiguration (Maybe CustomizedMetricSpecification)
targetTrackingConfiguration_customizedMetricSpecification = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TargetTrackingConfiguration' {Maybe CustomizedMetricSpecification
customizedMetricSpecification :: Maybe CustomizedMetricSpecification
$sel:customizedMetricSpecification:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe CustomizedMetricSpecification
customizedMetricSpecification} -> Maybe CustomizedMetricSpecification
customizedMetricSpecification) (\s :: TargetTrackingConfiguration
s@TargetTrackingConfiguration' {} Maybe CustomizedMetricSpecification
a -> TargetTrackingConfiguration
s {$sel:customizedMetricSpecification:TargetTrackingConfiguration' :: Maybe CustomizedMetricSpecification
customizedMetricSpecification = Maybe CustomizedMetricSpecification
a} :: TargetTrackingConfiguration)

-- | Indicates whether scaling in by the target tracking scaling policy is
-- disabled. If scaling in is disabled, the target tracking scaling policy
-- doesn\'t remove instances from the Auto Scaling group. Otherwise, the
-- target tracking scaling policy can remove instances from the Auto
-- Scaling group. The default is @false@.
targetTrackingConfiguration_disableScaleIn :: Lens.Lens' TargetTrackingConfiguration (Prelude.Maybe Prelude.Bool)
targetTrackingConfiguration_disableScaleIn :: Lens' TargetTrackingConfiguration (Maybe Bool)
targetTrackingConfiguration_disableScaleIn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TargetTrackingConfiguration' {Maybe Bool
disableScaleIn :: Maybe Bool
$sel:disableScaleIn:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe Bool
disableScaleIn} -> Maybe Bool
disableScaleIn) (\s :: TargetTrackingConfiguration
s@TargetTrackingConfiguration' {} Maybe Bool
a -> TargetTrackingConfiguration
s {$sel:disableScaleIn:TargetTrackingConfiguration' :: Maybe Bool
disableScaleIn = Maybe Bool
a} :: TargetTrackingConfiguration)

-- | A predefined metric. You must specify either a predefined metric or a
-- customized metric.
targetTrackingConfiguration_predefinedMetricSpecification :: Lens.Lens' TargetTrackingConfiguration (Prelude.Maybe PredefinedMetricSpecification)
targetTrackingConfiguration_predefinedMetricSpecification :: Lens'
  TargetTrackingConfiguration (Maybe PredefinedMetricSpecification)
targetTrackingConfiguration_predefinedMetricSpecification = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TargetTrackingConfiguration' {Maybe PredefinedMetricSpecification
predefinedMetricSpecification :: Maybe PredefinedMetricSpecification
$sel:predefinedMetricSpecification:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe PredefinedMetricSpecification
predefinedMetricSpecification} -> Maybe PredefinedMetricSpecification
predefinedMetricSpecification) (\s :: TargetTrackingConfiguration
s@TargetTrackingConfiguration' {} Maybe PredefinedMetricSpecification
a -> TargetTrackingConfiguration
s {$sel:predefinedMetricSpecification:TargetTrackingConfiguration' :: Maybe PredefinedMetricSpecification
predefinedMetricSpecification = Maybe PredefinedMetricSpecification
a} :: TargetTrackingConfiguration)

-- | The target value for the metric.
--
-- Some metrics are based on a count instead of a percentage, such as the
-- request count for an Application Load Balancer or the number of messages
-- in an SQS queue. If the scaling policy specifies one of these metrics,
-- specify the target utilization as the optimal average request or message
-- count per instance during any one-minute interval.
targetTrackingConfiguration_targetValue :: Lens.Lens' TargetTrackingConfiguration Prelude.Double
targetTrackingConfiguration_targetValue :: Lens' TargetTrackingConfiguration Double
targetTrackingConfiguration_targetValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TargetTrackingConfiguration' {Double
targetValue :: Double
$sel:targetValue:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Double
targetValue} -> Double
targetValue) (\s :: TargetTrackingConfiguration
s@TargetTrackingConfiguration' {} Double
a -> TargetTrackingConfiguration
s {$sel:targetValue:TargetTrackingConfiguration' :: Double
targetValue = Double
a} :: TargetTrackingConfiguration)

instance Data.FromXML TargetTrackingConfiguration where
  parseXML :: [Node] -> Either String TargetTrackingConfiguration
parseXML [Node]
x =
    Maybe CustomizedMetricSpecification
-> Maybe Bool
-> Maybe PredefinedMetricSpecification
-> Double
-> TargetTrackingConfiguration
TargetTrackingConfiguration'
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"CustomizedMetricSpecification")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"DisableScaleIn")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"PredefinedMetricSpecification")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String a
Data..@ Text
"TargetValue")

instance Prelude.Hashable TargetTrackingConfiguration where
  hashWithSalt :: Int -> TargetTrackingConfiguration -> Int
hashWithSalt Int
_salt TargetTrackingConfiguration' {Double
Maybe Bool
Maybe PredefinedMetricSpecification
Maybe CustomizedMetricSpecification
targetValue :: Double
predefinedMetricSpecification :: Maybe PredefinedMetricSpecification
disableScaleIn :: Maybe Bool
customizedMetricSpecification :: Maybe CustomizedMetricSpecification
$sel:targetValue:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Double
$sel:predefinedMetricSpecification:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe PredefinedMetricSpecification
$sel:disableScaleIn:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe Bool
$sel:customizedMetricSpecification:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe CustomizedMetricSpecification
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CustomizedMetricSpecification
customizedMetricSpecification
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
disableScaleIn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PredefinedMetricSpecification
predefinedMetricSpecification
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Double
targetValue

instance Prelude.NFData TargetTrackingConfiguration where
  rnf :: TargetTrackingConfiguration -> ()
rnf TargetTrackingConfiguration' {Double
Maybe Bool
Maybe PredefinedMetricSpecification
Maybe CustomizedMetricSpecification
targetValue :: Double
predefinedMetricSpecification :: Maybe PredefinedMetricSpecification
disableScaleIn :: Maybe Bool
customizedMetricSpecification :: Maybe CustomizedMetricSpecification
$sel:targetValue:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Double
$sel:predefinedMetricSpecification:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe PredefinedMetricSpecification
$sel:disableScaleIn:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe Bool
$sel:customizedMetricSpecification:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe CustomizedMetricSpecification
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe CustomizedMetricSpecification
customizedMetricSpecification
      seq :: forall a b. a -> b -> b
`Prelude.seq` 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 PredefinedMetricSpecification
predefinedMetricSpecification
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Double
targetValue

instance Data.ToQuery TargetTrackingConfiguration where
  toQuery :: TargetTrackingConfiguration -> QueryString
toQuery TargetTrackingConfiguration' {Double
Maybe Bool
Maybe PredefinedMetricSpecification
Maybe CustomizedMetricSpecification
targetValue :: Double
predefinedMetricSpecification :: Maybe PredefinedMetricSpecification
disableScaleIn :: Maybe Bool
customizedMetricSpecification :: Maybe CustomizedMetricSpecification
$sel:targetValue:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Double
$sel:predefinedMetricSpecification:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe PredefinedMetricSpecification
$sel:disableScaleIn:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe Bool
$sel:customizedMetricSpecification:TargetTrackingConfiguration' :: TargetTrackingConfiguration -> Maybe CustomizedMetricSpecification
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"CustomizedMetricSpecification"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe CustomizedMetricSpecification
customizedMetricSpecification,
        ByteString
"DisableScaleIn" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Bool
disableScaleIn,
        ByteString
"PredefinedMetricSpecification"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe PredefinedMetricSpecification
predefinedMetricSpecification,
        ByteString
"TargetValue" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Double
targetValue
      ]