RefreshPreferences.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.AutoScaling.Types.RefreshPreferences
-- 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.RefreshPreferences 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

-- | Describes the preferences for an instance refresh.
--
-- /See:/ 'newRefreshPreferences' smart constructor.
data RefreshPreferences = RefreshPreferences'
  { -- | The amount of time, in seconds, to wait after a checkpoint before
    -- continuing. This property is optional, but if you specify a value for
    -- it, you must also specify a value for @CheckpointPercentages@. If you
    -- specify a value for @CheckpointPercentages@ and not for
    -- @CheckpointDelay@, the @CheckpointDelay@ defaults to @3600@ (1 hour).
    checkpointDelay :: Prelude.Maybe Prelude.Natural,
    -- | Threshold values for each checkpoint in ascending order. Each number
    -- must be unique. To replace all instances in the Auto Scaling group, the
    -- last number in the array must be @100@.
    --
    -- For usage examples, see
    -- <https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-adding-checkpoints-instance-refresh.html Adding checkpoints to an instance refresh>
    -- in the /Amazon EC2 Auto Scaling User Guide/.
    checkpointPercentages :: Prelude.Maybe [Prelude.Natural],
    -- | /Not needed if the default instance warmup is defined for the group./
    --
    -- The duration of the instance warmup, in seconds.
    --
    -- The default is to use the value for the default instance warmup defined
    -- for the group. If default instance warmup is null, then @InstanceWarmup@
    -- falls back to the value of the health check grace period.
    instanceWarmup :: Prelude.Maybe Prelude.Natural,
    -- | The amount of capacity in the Auto Scaling group that must pass your
    -- group\'s health checks to allow the operation to continue. The value is
    -- expressed as a percentage of the desired capacity of the Auto Scaling
    -- group (rounded up to the nearest integer). The default is @90@.
    --
    -- Setting the minimum healthy percentage to 100 percent limits the rate of
    -- replacement to one instance at a time. In contrast, setting it to 0
    -- percent has the effect of replacing all instances at the same time.
    minHealthyPercentage :: Prelude.Maybe Prelude.Natural,
    -- | A boolean value that indicates whether skip matching is enabled. If
    -- true, then Amazon EC2 Auto Scaling skips replacing instances that match
    -- the desired configuration. If no desired configuration is specified,
    -- then it skips replacing instances that have the same configuration that
    -- is already set on the group. The default is @false@.
    skipMatching :: Prelude.Maybe Prelude.Bool
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'RefreshPreferences' 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:
--
-- 'checkpointDelay', 'refreshPreferences_checkpointDelay' - The amount of time, in seconds, to wait after a checkpoint before
-- continuing. This property is optional, but if you specify a value for
-- it, you must also specify a value for @CheckpointPercentages@. If you
-- specify a value for @CheckpointPercentages@ and not for
-- @CheckpointDelay@, the @CheckpointDelay@ defaults to @3600@ (1 hour).
--
-- 'checkpointPercentages', 'refreshPreferences_checkpointPercentages' - Threshold values for each checkpoint in ascending order. Each number
-- must be unique. To replace all instances in the Auto Scaling group, the
-- last number in the array must be @100@.
--
-- For usage examples, see
-- <https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-adding-checkpoints-instance-refresh.html Adding checkpoints to an instance refresh>
-- in the /Amazon EC2 Auto Scaling User Guide/.
--
-- 'instanceWarmup', 'refreshPreferences_instanceWarmup' - /Not needed if the default instance warmup is defined for the group./
--
-- The duration of the instance warmup, in seconds.
--
-- The default is to use the value for the default instance warmup defined
-- for the group. If default instance warmup is null, then @InstanceWarmup@
-- falls back to the value of the health check grace period.
--
-- 'minHealthyPercentage', 'refreshPreferences_minHealthyPercentage' - The amount of capacity in the Auto Scaling group that must pass your
-- group\'s health checks to allow the operation to continue. The value is
-- expressed as a percentage of the desired capacity of the Auto Scaling
-- group (rounded up to the nearest integer). The default is @90@.
--
-- Setting the minimum healthy percentage to 100 percent limits the rate of
-- replacement to one instance at a time. In contrast, setting it to 0
-- percent has the effect of replacing all instances at the same time.
--
-- 'skipMatching', 'refreshPreferences_skipMatching' - A boolean value that indicates whether skip matching is enabled. If
-- true, then Amazon EC2 Auto Scaling skips replacing instances that match
-- the desired configuration. If no desired configuration is specified,
-- then it skips replacing instances that have the same configuration that
-- is already set on the group. The default is @false@.
newRefreshPreferences ::
  RefreshPreferences
newRefreshPreferences =
  RefreshPreferences'
    { checkpointDelay =
        Prelude.Nothing,
      checkpointPercentages = Prelude.Nothing,
      instanceWarmup = Prelude.Nothing,
      minHealthyPercentage = Prelude.Nothing,
      skipMatching = Prelude.Nothing
    }

-- | The amount of time, in seconds, to wait after a checkpoint before
-- continuing. This property is optional, but if you specify a value for
-- it, you must also specify a value for @CheckpointPercentages@. If you
-- specify a value for @CheckpointPercentages@ and not for
-- @CheckpointDelay@, the @CheckpointDelay@ defaults to @3600@ (1 hour).
refreshPreferences_checkpointDelay :: Lens.Lens' RefreshPreferences (Prelude.Maybe Prelude.Natural)
refreshPreferences_checkpointDelay = Lens.lens (\RefreshPreferences' {checkpointDelay} -> checkpointDelay) (\s@RefreshPreferences' {} a -> s {checkpointDelay = a} :: RefreshPreferences)

-- | Threshold values for each checkpoint in ascending order. Each number
-- must be unique. To replace all instances in the Auto Scaling group, the
-- last number in the array must be @100@.
--
-- For usage examples, see
-- <https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-adding-checkpoints-instance-refresh.html Adding checkpoints to an instance refresh>
-- in the /Amazon EC2 Auto Scaling User Guide/.
refreshPreferences_checkpointPercentages :: Lens.Lens' RefreshPreferences (Prelude.Maybe [Prelude.Natural])
refreshPreferences_checkpointPercentages = Lens.lens (\RefreshPreferences' {checkpointPercentages} -> checkpointPercentages) (\s@RefreshPreferences' {} a -> s {checkpointPercentages = a} :: RefreshPreferences) Prelude.. Lens.mapping Lens.coerced

-- | /Not needed if the default instance warmup is defined for the group./
--
-- The duration of the instance warmup, in seconds.
--
-- The default is to use the value for the default instance warmup defined
-- for the group. If default instance warmup is null, then @InstanceWarmup@
-- falls back to the value of the health check grace period.
refreshPreferences_instanceWarmup :: Lens.Lens' RefreshPreferences (Prelude.Maybe Prelude.Natural)
refreshPreferences_instanceWarmup = Lens.lens (\RefreshPreferences' {instanceWarmup} -> instanceWarmup) (\s@RefreshPreferences' {} a -> s {instanceWarmup = a} :: RefreshPreferences)

-- | The amount of capacity in the Auto Scaling group that must pass your
-- group\'s health checks to allow the operation to continue. The value is
-- expressed as a percentage of the desired capacity of the Auto Scaling
-- group (rounded up to the nearest integer). The default is @90@.
--
-- Setting the minimum healthy percentage to 100 percent limits the rate of
-- replacement to one instance at a time. In contrast, setting it to 0
-- percent has the effect of replacing all instances at the same time.
refreshPreferences_minHealthyPercentage :: Lens.Lens' RefreshPreferences (Prelude.Maybe Prelude.Natural)
refreshPreferences_minHealthyPercentage = Lens.lens (\RefreshPreferences' {minHealthyPercentage} -> minHealthyPercentage) (\s@RefreshPreferences' {} a -> s {minHealthyPercentage = a} :: RefreshPreferences)

-- | A boolean value that indicates whether skip matching is enabled. If
-- true, then Amazon EC2 Auto Scaling skips replacing instances that match
-- the desired configuration. If no desired configuration is specified,
-- then it skips replacing instances that have the same configuration that
-- is already set on the group. The default is @false@.
refreshPreferences_skipMatching :: Lens.Lens' RefreshPreferences (Prelude.Maybe Prelude.Bool)
refreshPreferences_skipMatching = Lens.lens (\RefreshPreferences' {skipMatching} -> skipMatching) (\s@RefreshPreferences' {} a -> s {skipMatching = a} :: RefreshPreferences)

instance Data.FromXML RefreshPreferences where
  parseXML x =
    RefreshPreferences'
      Prelude.<$> (x Data..@? "CheckpointDelay")
      Prelude.<*> ( x
                      Data..@? "CheckpointPercentages"
                      Core..!@ Prelude.mempty
                      Prelude.>>= Core.may (Data.parseXMLList "member")
                  )
      Prelude.<*> (x Data..@? "InstanceWarmup")
      Prelude.<*> (x Data..@? "MinHealthyPercentage")
      Prelude.<*> (x Data..@? "SkipMatching")

instance Prelude.Hashable RefreshPreferences where
  hashWithSalt _salt RefreshPreferences' {..} =
    _salt
      `Prelude.hashWithSalt` checkpointDelay
      `Prelude.hashWithSalt` checkpointPercentages
      `Prelude.hashWithSalt` instanceWarmup
      `Prelude.hashWithSalt` minHealthyPercentage
      `Prelude.hashWithSalt` skipMatching

instance Prelude.NFData RefreshPreferences where
  rnf RefreshPreferences' {..} =
    Prelude.rnf checkpointDelay
      `Prelude.seq` Prelude.rnf checkpointPercentages
      `Prelude.seq` Prelude.rnf instanceWarmup
      `Prelude.seq` Prelude.rnf minHealthyPercentage
      `Prelude.seq` Prelude.rnf skipMatching

instance Data.ToQuery RefreshPreferences where
  toQuery RefreshPreferences' {..} =
    Prelude.mconcat
      [ "CheckpointDelay" Data.=: checkpointDelay,
        "CheckpointPercentages"
          Data.=: Data.toQuery
            ( Data.toQueryList "member"
                Prelude.<$> checkpointPercentages
            ),
        "InstanceWarmup" Data.=: instanceWarmup,
        "MinHealthyPercentage" Data.=: minHealthyPercentage,
        "SkipMatching" Data.=: skipMatching
      ]