{-# 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.ECS.Types.CapacityProviderStrategyItem
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.ECS.Types.CapacityProviderStrategyItem where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | The details of a capacity provider strategy. A capacity provider
-- strategy can be set when using the RunTask or CreateCluster APIs or as
-- the default capacity provider strategy for a cluster with the
-- CreateCluster API.
--
-- Only capacity providers that are already associated with a cluster and
-- have an @ACTIVE@ or @UPDATING@ status can be used in a capacity provider
-- strategy. The PutClusterCapacityProviders API is used to associate a
-- capacity provider with a cluster.
--
-- If specifying a capacity provider that uses an Auto Scaling group, the
-- capacity provider must already be created. New Auto Scaling group
-- capacity providers can be created with the CreateCapacityProvider API
-- operation.
--
-- To use a Fargate capacity provider, specify either the @FARGATE@ or
-- @FARGATE_SPOT@ capacity providers. The Fargate capacity providers are
-- available to all accounts and only need to be associated with a cluster
-- to be used in a capacity provider strategy.
--
-- A capacity provider strategy may contain a maximum of 6 capacity
-- providers.
--
-- /See:/ 'newCapacityProviderStrategyItem' smart constructor.
data CapacityProviderStrategyItem = CapacityProviderStrategyItem'
  { -- | The /base/ value designates how many tasks, at a minimum, to run on the
    -- specified capacity provider. Only one capacity provider in a capacity
    -- provider strategy can have a /base/ defined. If no value is specified,
    -- the default value of @0@ is used.
    CapacityProviderStrategyItem -> Maybe Natural
base :: Prelude.Maybe Prelude.Natural,
    -- | The /weight/ value designates the relative percentage of the total
    -- number of tasks launched that should use the specified capacity
    -- provider. The @weight@ value is taken into consideration after the
    -- @base@ value, if defined, is satisfied.
    --
    -- If no @weight@ value is specified, the default value of @0@ is used.
    -- When multiple capacity providers are specified within a capacity
    -- provider strategy, at least one of the capacity providers must have a
    -- weight value greater than zero and any capacity providers with a weight
    -- of @0@ will not be used to place tasks. If you specify multiple capacity
    -- providers in a strategy that all have a weight of @0@, any @RunTask@ or
    -- @CreateService@ actions using the capacity provider strategy will fail.
    --
    -- An example scenario for using weights is defining a strategy that
    -- contains two capacity providers and both have a weight of @1@, then when
    -- the @base@ is satisfied, the tasks will be split evenly across the two
    -- capacity providers. Using that same logic, if you specify a weight of
    -- @1@ for /capacityProviderA/ and a weight of @4@ for /capacityProviderB/,
    -- then for every one task that is run using /capacityProviderA/, four
    -- tasks would use /capacityProviderB/.
    CapacityProviderStrategyItem -> Maybe Natural
weight :: Prelude.Maybe Prelude.Natural,
    -- | The short name of the capacity provider.
    CapacityProviderStrategyItem -> Text
capacityProvider :: Prelude.Text
  }
  deriving (CapacityProviderStrategyItem
-> CapacityProviderStrategyItem -> Bool
(CapacityProviderStrategyItem
 -> CapacityProviderStrategyItem -> Bool)
-> (CapacityProviderStrategyItem
    -> CapacityProviderStrategyItem -> Bool)
-> Eq CapacityProviderStrategyItem
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CapacityProviderStrategyItem
-> CapacityProviderStrategyItem -> Bool
$c/= :: CapacityProviderStrategyItem
-> CapacityProviderStrategyItem -> Bool
== :: CapacityProviderStrategyItem
-> CapacityProviderStrategyItem -> Bool
$c== :: CapacityProviderStrategyItem
-> CapacityProviderStrategyItem -> Bool
Prelude.Eq, ReadPrec [CapacityProviderStrategyItem]
ReadPrec CapacityProviderStrategyItem
Int -> ReadS CapacityProviderStrategyItem
ReadS [CapacityProviderStrategyItem]
(Int -> ReadS CapacityProviderStrategyItem)
-> ReadS [CapacityProviderStrategyItem]
-> ReadPrec CapacityProviderStrategyItem
-> ReadPrec [CapacityProviderStrategyItem]
-> Read CapacityProviderStrategyItem
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CapacityProviderStrategyItem]
$creadListPrec :: ReadPrec [CapacityProviderStrategyItem]
readPrec :: ReadPrec CapacityProviderStrategyItem
$creadPrec :: ReadPrec CapacityProviderStrategyItem
readList :: ReadS [CapacityProviderStrategyItem]
$creadList :: ReadS [CapacityProviderStrategyItem]
readsPrec :: Int -> ReadS CapacityProviderStrategyItem
$creadsPrec :: Int -> ReadS CapacityProviderStrategyItem
Prelude.Read, Int -> CapacityProviderStrategyItem -> ShowS
[CapacityProviderStrategyItem] -> ShowS
CapacityProviderStrategyItem -> String
(Int -> CapacityProviderStrategyItem -> ShowS)
-> (CapacityProviderStrategyItem -> String)
-> ([CapacityProviderStrategyItem] -> ShowS)
-> Show CapacityProviderStrategyItem
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CapacityProviderStrategyItem] -> ShowS
$cshowList :: [CapacityProviderStrategyItem] -> ShowS
show :: CapacityProviderStrategyItem -> String
$cshow :: CapacityProviderStrategyItem -> String
showsPrec :: Int -> CapacityProviderStrategyItem -> ShowS
$cshowsPrec :: Int -> CapacityProviderStrategyItem -> ShowS
Prelude.Show, (forall x.
 CapacityProviderStrategyItem -> Rep CapacityProviderStrategyItem x)
-> (forall x.
    Rep CapacityProviderStrategyItem x -> CapacityProviderStrategyItem)
-> Generic CapacityProviderStrategyItem
forall x.
Rep CapacityProviderStrategyItem x -> CapacityProviderStrategyItem
forall x.
CapacityProviderStrategyItem -> Rep CapacityProviderStrategyItem x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CapacityProviderStrategyItem x -> CapacityProviderStrategyItem
$cfrom :: forall x.
CapacityProviderStrategyItem -> Rep CapacityProviderStrategyItem x
Prelude.Generic)

-- |
-- Create a value of 'CapacityProviderStrategyItem' 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:
--
-- 'base', 'capacityProviderStrategyItem_base' - The /base/ value designates how many tasks, at a minimum, to run on the
-- specified capacity provider. Only one capacity provider in a capacity
-- provider strategy can have a /base/ defined. If no value is specified,
-- the default value of @0@ is used.
--
-- 'weight', 'capacityProviderStrategyItem_weight' - The /weight/ value designates the relative percentage of the total
-- number of tasks launched that should use the specified capacity
-- provider. The @weight@ value is taken into consideration after the
-- @base@ value, if defined, is satisfied.
--
-- If no @weight@ value is specified, the default value of @0@ is used.
-- When multiple capacity providers are specified within a capacity
-- provider strategy, at least one of the capacity providers must have a
-- weight value greater than zero and any capacity providers with a weight
-- of @0@ will not be used to place tasks. If you specify multiple capacity
-- providers in a strategy that all have a weight of @0@, any @RunTask@ or
-- @CreateService@ actions using the capacity provider strategy will fail.
--
-- An example scenario for using weights is defining a strategy that
-- contains two capacity providers and both have a weight of @1@, then when
-- the @base@ is satisfied, the tasks will be split evenly across the two
-- capacity providers. Using that same logic, if you specify a weight of
-- @1@ for /capacityProviderA/ and a weight of @4@ for /capacityProviderB/,
-- then for every one task that is run using /capacityProviderA/, four
-- tasks would use /capacityProviderB/.
--
-- 'capacityProvider', 'capacityProviderStrategyItem_capacityProvider' - The short name of the capacity provider.
newCapacityProviderStrategyItem ::
  -- | 'capacityProvider'
  Prelude.Text ->
  CapacityProviderStrategyItem
newCapacityProviderStrategyItem :: Text -> CapacityProviderStrategyItem
newCapacityProviderStrategyItem Text
pCapacityProvider_ =
  CapacityProviderStrategyItem' :: Maybe Natural
-> Maybe Natural -> Text -> CapacityProviderStrategyItem
CapacityProviderStrategyItem'
    { $sel:base:CapacityProviderStrategyItem' :: Maybe Natural
base =
        Maybe Natural
forall a. Maybe a
Prelude.Nothing,
      $sel:weight:CapacityProviderStrategyItem' :: Maybe Natural
weight = Maybe Natural
forall a. Maybe a
Prelude.Nothing,
      $sel:capacityProvider:CapacityProviderStrategyItem' :: Text
capacityProvider = Text
pCapacityProvider_
    }

-- | The /base/ value designates how many tasks, at a minimum, to run on the
-- specified capacity provider. Only one capacity provider in a capacity
-- provider strategy can have a /base/ defined. If no value is specified,
-- the default value of @0@ is used.
capacityProviderStrategyItem_base :: Lens.Lens' CapacityProviderStrategyItem (Prelude.Maybe Prelude.Natural)
capacityProviderStrategyItem_base :: (Maybe Natural -> f (Maybe Natural))
-> CapacityProviderStrategyItem -> f CapacityProviderStrategyItem
capacityProviderStrategyItem_base = (CapacityProviderStrategyItem -> Maybe Natural)
-> (CapacityProviderStrategyItem
    -> Maybe Natural -> CapacityProviderStrategyItem)
-> Lens
     CapacityProviderStrategyItem
     CapacityProviderStrategyItem
     (Maybe Natural)
     (Maybe Natural)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CapacityProviderStrategyItem' {Maybe Natural
base :: Maybe Natural
$sel:base:CapacityProviderStrategyItem' :: CapacityProviderStrategyItem -> Maybe Natural
base} -> Maybe Natural
base) (\s :: CapacityProviderStrategyItem
s@CapacityProviderStrategyItem' {} Maybe Natural
a -> CapacityProviderStrategyItem
s {$sel:base:CapacityProviderStrategyItem' :: Maybe Natural
base = Maybe Natural
a} :: CapacityProviderStrategyItem)

-- | The /weight/ value designates the relative percentage of the total
-- number of tasks launched that should use the specified capacity
-- provider. The @weight@ value is taken into consideration after the
-- @base@ value, if defined, is satisfied.
--
-- If no @weight@ value is specified, the default value of @0@ is used.
-- When multiple capacity providers are specified within a capacity
-- provider strategy, at least one of the capacity providers must have a
-- weight value greater than zero and any capacity providers with a weight
-- of @0@ will not be used to place tasks. If you specify multiple capacity
-- providers in a strategy that all have a weight of @0@, any @RunTask@ or
-- @CreateService@ actions using the capacity provider strategy will fail.
--
-- An example scenario for using weights is defining a strategy that
-- contains two capacity providers and both have a weight of @1@, then when
-- the @base@ is satisfied, the tasks will be split evenly across the two
-- capacity providers. Using that same logic, if you specify a weight of
-- @1@ for /capacityProviderA/ and a weight of @4@ for /capacityProviderB/,
-- then for every one task that is run using /capacityProviderA/, four
-- tasks would use /capacityProviderB/.
capacityProviderStrategyItem_weight :: Lens.Lens' CapacityProviderStrategyItem (Prelude.Maybe Prelude.Natural)
capacityProviderStrategyItem_weight :: (Maybe Natural -> f (Maybe Natural))
-> CapacityProviderStrategyItem -> f CapacityProviderStrategyItem
capacityProviderStrategyItem_weight = (CapacityProviderStrategyItem -> Maybe Natural)
-> (CapacityProviderStrategyItem
    -> Maybe Natural -> CapacityProviderStrategyItem)
-> Lens
     CapacityProviderStrategyItem
     CapacityProviderStrategyItem
     (Maybe Natural)
     (Maybe Natural)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CapacityProviderStrategyItem' {Maybe Natural
weight :: Maybe Natural
$sel:weight:CapacityProviderStrategyItem' :: CapacityProviderStrategyItem -> Maybe Natural
weight} -> Maybe Natural
weight) (\s :: CapacityProviderStrategyItem
s@CapacityProviderStrategyItem' {} Maybe Natural
a -> CapacityProviderStrategyItem
s {$sel:weight:CapacityProviderStrategyItem' :: Maybe Natural
weight = Maybe Natural
a} :: CapacityProviderStrategyItem)

-- | The short name of the capacity provider.
capacityProviderStrategyItem_capacityProvider :: Lens.Lens' CapacityProviderStrategyItem Prelude.Text
capacityProviderStrategyItem_capacityProvider :: (Text -> f Text)
-> CapacityProviderStrategyItem -> f CapacityProviderStrategyItem
capacityProviderStrategyItem_capacityProvider = (CapacityProviderStrategyItem -> Text)
-> (CapacityProviderStrategyItem
    -> Text -> CapacityProviderStrategyItem)
-> Lens
     CapacityProviderStrategyItem CapacityProviderStrategyItem Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CapacityProviderStrategyItem' {Text
capacityProvider :: Text
$sel:capacityProvider:CapacityProviderStrategyItem' :: CapacityProviderStrategyItem -> Text
capacityProvider} -> Text
capacityProvider) (\s :: CapacityProviderStrategyItem
s@CapacityProviderStrategyItem' {} Text
a -> CapacityProviderStrategyItem
s {$sel:capacityProvider:CapacityProviderStrategyItem' :: Text
capacityProvider = Text
a} :: CapacityProviderStrategyItem)

instance Core.FromJSON CapacityProviderStrategyItem where
  parseJSON :: Value -> Parser CapacityProviderStrategyItem
parseJSON =
    String
-> (Object -> Parser CapacityProviderStrategyItem)
-> Value
-> Parser CapacityProviderStrategyItem
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"CapacityProviderStrategyItem"
      ( \Object
x ->
          Maybe Natural
-> Maybe Natural -> Text -> CapacityProviderStrategyItem
CapacityProviderStrategyItem'
            (Maybe Natural
 -> Maybe Natural -> Text -> CapacityProviderStrategyItem)
-> Parser (Maybe Natural)
-> Parser (Maybe Natural -> Text -> CapacityProviderStrategyItem)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe Natural)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"base")
            Parser (Maybe Natural -> Text -> CapacityProviderStrategyItem)
-> Parser (Maybe Natural)
-> Parser (Text -> CapacityProviderStrategyItem)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Natural)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"weight")
            Parser (Text -> CapacityProviderStrategyItem)
-> Parser Text -> Parser CapacityProviderStrategyItem
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser Text
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"capacityProvider")
      )

instance
  Prelude.Hashable
    CapacityProviderStrategyItem

instance Prelude.NFData CapacityProviderStrategyItem

instance Core.ToJSON CapacityProviderStrategyItem where
  toJSON :: CapacityProviderStrategyItem -> Value
toJSON CapacityProviderStrategyItem' {Maybe Natural
Text
capacityProvider :: Text
weight :: Maybe Natural
base :: Maybe Natural
$sel:capacityProvider:CapacityProviderStrategyItem' :: CapacityProviderStrategyItem -> Text
$sel:weight:CapacityProviderStrategyItem' :: CapacityProviderStrategyItem -> Maybe Natural
$sel:base:CapacityProviderStrategyItem' :: CapacityProviderStrategyItem -> Maybe Natural
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"base" Text -> Natural -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Natural -> Pair) -> Maybe Natural -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
base,
            (Text
"weight" Text -> Natural -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Natural -> Pair) -> Maybe Natural -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
weight,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              (Text
"capacityProvider" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
capacityProvider)
          ]
      )