PlacementStrategy.hs

{-# 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.Scheduler.Types.PlacementStrategy
-- 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.Scheduler.Types.PlacementStrategy where

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
import Amazonka.Scheduler.Types.PlacementStrategyType

-- | The task placement strategy for a task or service.
--
-- /See:/ 'newPlacementStrategy' smart constructor.
data PlacementStrategy = PlacementStrategy'
  { -- | The field to apply the placement strategy against. For the spread
    -- placement strategy, valid values are @instanceId@ (or @instanceId@,
    -- which has the same effect), or any platform or custom attribute that is
    -- applied to a container instance, such as
    -- @attribute:ecs.availability-zone@. For the binpack placement strategy,
    -- valid values are @cpu@ and @memory@. For the random placement strategy,
    -- this field is not used.
    field :: Prelude.Maybe Prelude.Text,
    -- | The type of placement strategy. The random placement strategy randomly
    -- places tasks on available candidates. The spread placement strategy
    -- spreads placement across available candidates evenly based on the field
    -- parameter. The binpack strategy places tasks on available candidates
    -- that have the least available amount of the resource that is specified
    -- with the field parameter. For example, if you binpack on memory, a task
    -- is placed on the instance with the least amount of remaining memory (but
    -- still enough to run the task).
    type' :: Prelude.Maybe PlacementStrategyType
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'PlacementStrategy' 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:
--
-- 'field', 'placementStrategy_field' - The field to apply the placement strategy against. For the spread
-- placement strategy, valid values are @instanceId@ (or @instanceId@,
-- which has the same effect), or any platform or custom attribute that is
-- applied to a container instance, such as
-- @attribute:ecs.availability-zone@. For the binpack placement strategy,
-- valid values are @cpu@ and @memory@. For the random placement strategy,
-- this field is not used.
--
-- 'type'', 'placementStrategy_type' - The type of placement strategy. The random placement strategy randomly
-- places tasks on available candidates. The spread placement strategy
-- spreads placement across available candidates evenly based on the field
-- parameter. The binpack strategy places tasks on available candidates
-- that have the least available amount of the resource that is specified
-- with the field parameter. For example, if you binpack on memory, a task
-- is placed on the instance with the least amount of remaining memory (but
-- still enough to run the task).
newPlacementStrategy ::
  PlacementStrategy
newPlacementStrategy =
  PlacementStrategy'
    { field = Prelude.Nothing,
      type' = Prelude.Nothing
    }

-- | The field to apply the placement strategy against. For the spread
-- placement strategy, valid values are @instanceId@ (or @instanceId@,
-- which has the same effect), or any platform or custom attribute that is
-- applied to a container instance, such as
-- @attribute:ecs.availability-zone@. For the binpack placement strategy,
-- valid values are @cpu@ and @memory@. For the random placement strategy,
-- this field is not used.
placementStrategy_field :: Lens.Lens' PlacementStrategy (Prelude.Maybe Prelude.Text)
placementStrategy_field = Lens.lens (\PlacementStrategy' {field} -> field) (\s@PlacementStrategy' {} a -> s {field = a} :: PlacementStrategy)

-- | The type of placement strategy. The random placement strategy randomly
-- places tasks on available candidates. The spread placement strategy
-- spreads placement across available candidates evenly based on the field
-- parameter. The binpack strategy places tasks on available candidates
-- that have the least available amount of the resource that is specified
-- with the field parameter. For example, if you binpack on memory, a task
-- is placed on the instance with the least amount of remaining memory (but
-- still enough to run the task).
placementStrategy_type :: Lens.Lens' PlacementStrategy (Prelude.Maybe PlacementStrategyType)
placementStrategy_type = Lens.lens (\PlacementStrategy' {type'} -> type') (\s@PlacementStrategy' {} a -> s {type' = a} :: PlacementStrategy)

instance Data.FromJSON PlacementStrategy where
  parseJSON =
    Data.withObject
      "PlacementStrategy"
      ( \x ->
          PlacementStrategy'
            Prelude.<$> (x Data..:? "field")
            Prelude.<*> (x Data..:? "type")
      )

instance Prelude.Hashable PlacementStrategy where
  hashWithSalt _salt PlacementStrategy' {..} =
    _salt
      `Prelude.hashWithSalt` field
      `Prelude.hashWithSalt` type'

instance Prelude.NFData PlacementStrategy where
  rnf PlacementStrategy' {..} =
    Prelude.rnf field `Prelude.seq` Prelude.rnf type'

instance Data.ToJSON PlacementStrategy where
  toJSON PlacementStrategy' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("field" Data..=) Prelude.<$> field,
            ("type" Data..=) Prelude.<$> type'
          ]
      )