{-# 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.CloudFormation.Types.RollbackConfiguration
-- 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.CloudFormation.Types.RollbackConfiguration where

import Amazonka.CloudFormation.Types.RollbackTrigger
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

-- | Structure containing the rollback triggers for CloudFormation to monitor
-- during stack creation and updating operations, and for the specified
-- monitoring period afterwards.
--
-- Rollback triggers enable you to have CloudFormation monitor the state of
-- your application during stack creation and updating, and to roll back
-- that operation if the application breaches the threshold of any of the
-- alarms you\'ve specified. For more information, see
-- <http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html Monitor and Roll Back Stack Operations>.
--
-- /See:/ 'newRollbackConfiguration' smart constructor.
data RollbackConfiguration = RollbackConfiguration'
  { -- | The amount of time, in minutes, during which CloudFormation should
    -- monitor all the rollback triggers after the stack creation or update
    -- operation deploys all necessary resources.
    --
    -- The default is 0 minutes.
    --
    -- If you specify a monitoring period but don\'t specify any rollback
    -- triggers, CloudFormation still waits the specified period of time before
    -- cleaning up old resources after update operations. You can use this
    -- monitoring period to perform any manual stack validation desired, and
    -- manually cancel the stack creation or update (using
    -- <https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html CancelUpdateStack>,
    -- for example) as necessary.
    --
    -- If you specify 0 for this parameter, CloudFormation still monitors the
    -- specified rollback triggers during stack creation and update operations.
    -- Then, for update operations, it begins disposing of old resources
    -- immediately once the operation completes.
    RollbackConfiguration -> Maybe Natural
monitoringTimeInMinutes :: Prelude.Maybe Prelude.Natural,
    -- | The triggers to monitor during stack creation or update actions.
    --
    -- By default, CloudFormation saves the rollback triggers specified for a
    -- stack and applies them to any subsequent update operations for the
    -- stack, unless you specify otherwise. If you do specify rollback triggers
    -- for this parameter, those triggers replace any list of triggers
    -- previously specified for the stack. This means:
    --
    -- -   To use the rollback triggers previously specified for this stack, if
    --     any, don\'t specify this parameter.
    --
    -- -   To specify new or updated rollback triggers, you must specify /all/
    --     the triggers that you want used for this stack, even triggers
    --     you\'ve specified before (for example, when creating the stack or
    --     during a previous stack update). Any triggers that you don\'t
    --     include in the updated list of triggers are no longer applied to the
    --     stack.
    --
    -- -   To remove all currently specified triggers, specify an empty list
    --     for this parameter.
    --
    -- If a specified trigger is missing, the entire stack operation fails and
    -- is rolled back.
    RollbackConfiguration -> Maybe [RollbackTrigger]
rollbackTriggers :: Prelude.Maybe [RollbackTrigger]
  }
  deriving (RollbackConfiguration -> RollbackConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RollbackConfiguration -> RollbackConfiguration -> Bool
$c/= :: RollbackConfiguration -> RollbackConfiguration -> Bool
== :: RollbackConfiguration -> RollbackConfiguration -> Bool
$c== :: RollbackConfiguration -> RollbackConfiguration -> Bool
Prelude.Eq, ReadPrec [RollbackConfiguration]
ReadPrec RollbackConfiguration
Int -> ReadS RollbackConfiguration
ReadS [RollbackConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [RollbackConfiguration]
$creadListPrec :: ReadPrec [RollbackConfiguration]
readPrec :: ReadPrec RollbackConfiguration
$creadPrec :: ReadPrec RollbackConfiguration
readList :: ReadS [RollbackConfiguration]
$creadList :: ReadS [RollbackConfiguration]
readsPrec :: Int -> ReadS RollbackConfiguration
$creadsPrec :: Int -> ReadS RollbackConfiguration
Prelude.Read, Int -> RollbackConfiguration -> ShowS
[RollbackConfiguration] -> ShowS
RollbackConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RollbackConfiguration] -> ShowS
$cshowList :: [RollbackConfiguration] -> ShowS
show :: RollbackConfiguration -> String
$cshow :: RollbackConfiguration -> String
showsPrec :: Int -> RollbackConfiguration -> ShowS
$cshowsPrec :: Int -> RollbackConfiguration -> ShowS
Prelude.Show, forall x. Rep RollbackConfiguration x -> RollbackConfiguration
forall x. RollbackConfiguration -> Rep RollbackConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep RollbackConfiguration x -> RollbackConfiguration
$cfrom :: forall x. RollbackConfiguration -> Rep RollbackConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'RollbackConfiguration' 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:
--
-- 'monitoringTimeInMinutes', 'rollbackConfiguration_monitoringTimeInMinutes' - The amount of time, in minutes, during which CloudFormation should
-- monitor all the rollback triggers after the stack creation or update
-- operation deploys all necessary resources.
--
-- The default is 0 minutes.
--
-- If you specify a monitoring period but don\'t specify any rollback
-- triggers, CloudFormation still waits the specified period of time before
-- cleaning up old resources after update operations. You can use this
-- monitoring period to perform any manual stack validation desired, and
-- manually cancel the stack creation or update (using
-- <https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html CancelUpdateStack>,
-- for example) as necessary.
--
-- If you specify 0 for this parameter, CloudFormation still monitors the
-- specified rollback triggers during stack creation and update operations.
-- Then, for update operations, it begins disposing of old resources
-- immediately once the operation completes.
--
-- 'rollbackTriggers', 'rollbackConfiguration_rollbackTriggers' - The triggers to monitor during stack creation or update actions.
--
-- By default, CloudFormation saves the rollback triggers specified for a
-- stack and applies them to any subsequent update operations for the
-- stack, unless you specify otherwise. If you do specify rollback triggers
-- for this parameter, those triggers replace any list of triggers
-- previously specified for the stack. This means:
--
-- -   To use the rollback triggers previously specified for this stack, if
--     any, don\'t specify this parameter.
--
-- -   To specify new or updated rollback triggers, you must specify /all/
--     the triggers that you want used for this stack, even triggers
--     you\'ve specified before (for example, when creating the stack or
--     during a previous stack update). Any triggers that you don\'t
--     include in the updated list of triggers are no longer applied to the
--     stack.
--
-- -   To remove all currently specified triggers, specify an empty list
--     for this parameter.
--
-- If a specified trigger is missing, the entire stack operation fails and
-- is rolled back.
newRollbackConfiguration ::
  RollbackConfiguration
newRollbackConfiguration :: RollbackConfiguration
newRollbackConfiguration =
  RollbackConfiguration'
    { $sel:monitoringTimeInMinutes:RollbackConfiguration' :: Maybe Natural
monitoringTimeInMinutes =
        forall a. Maybe a
Prelude.Nothing,
      $sel:rollbackTriggers:RollbackConfiguration' :: Maybe [RollbackTrigger]
rollbackTriggers = forall a. Maybe a
Prelude.Nothing
    }

-- | The amount of time, in minutes, during which CloudFormation should
-- monitor all the rollback triggers after the stack creation or update
-- operation deploys all necessary resources.
--
-- The default is 0 minutes.
--
-- If you specify a monitoring period but don\'t specify any rollback
-- triggers, CloudFormation still waits the specified period of time before
-- cleaning up old resources after update operations. You can use this
-- monitoring period to perform any manual stack validation desired, and
-- manually cancel the stack creation or update (using
-- <https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html CancelUpdateStack>,
-- for example) as necessary.
--
-- If you specify 0 for this parameter, CloudFormation still monitors the
-- specified rollback triggers during stack creation and update operations.
-- Then, for update operations, it begins disposing of old resources
-- immediately once the operation completes.
rollbackConfiguration_monitoringTimeInMinutes :: Lens.Lens' RollbackConfiguration (Prelude.Maybe Prelude.Natural)
rollbackConfiguration_monitoringTimeInMinutes :: Lens' RollbackConfiguration (Maybe Natural)
rollbackConfiguration_monitoringTimeInMinutes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RollbackConfiguration' {Maybe Natural
monitoringTimeInMinutes :: Maybe Natural
$sel:monitoringTimeInMinutes:RollbackConfiguration' :: RollbackConfiguration -> Maybe Natural
monitoringTimeInMinutes} -> Maybe Natural
monitoringTimeInMinutes) (\s :: RollbackConfiguration
s@RollbackConfiguration' {} Maybe Natural
a -> RollbackConfiguration
s {$sel:monitoringTimeInMinutes:RollbackConfiguration' :: Maybe Natural
monitoringTimeInMinutes = Maybe Natural
a} :: RollbackConfiguration)

-- | The triggers to monitor during stack creation or update actions.
--
-- By default, CloudFormation saves the rollback triggers specified for a
-- stack and applies them to any subsequent update operations for the
-- stack, unless you specify otherwise. If you do specify rollback triggers
-- for this parameter, those triggers replace any list of triggers
-- previously specified for the stack. This means:
--
-- -   To use the rollback triggers previously specified for this stack, if
--     any, don\'t specify this parameter.
--
-- -   To specify new or updated rollback triggers, you must specify /all/
--     the triggers that you want used for this stack, even triggers
--     you\'ve specified before (for example, when creating the stack or
--     during a previous stack update). Any triggers that you don\'t
--     include in the updated list of triggers are no longer applied to the
--     stack.
--
-- -   To remove all currently specified triggers, specify an empty list
--     for this parameter.
--
-- If a specified trigger is missing, the entire stack operation fails and
-- is rolled back.
rollbackConfiguration_rollbackTriggers :: Lens.Lens' RollbackConfiguration (Prelude.Maybe [RollbackTrigger])
rollbackConfiguration_rollbackTriggers :: Lens' RollbackConfiguration (Maybe [RollbackTrigger])
rollbackConfiguration_rollbackTriggers = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RollbackConfiguration' {Maybe [RollbackTrigger]
rollbackTriggers :: Maybe [RollbackTrigger]
$sel:rollbackTriggers:RollbackConfiguration' :: RollbackConfiguration -> Maybe [RollbackTrigger]
rollbackTriggers} -> Maybe [RollbackTrigger]
rollbackTriggers) (\s :: RollbackConfiguration
s@RollbackConfiguration' {} Maybe [RollbackTrigger]
a -> RollbackConfiguration
s {$sel:rollbackTriggers:RollbackConfiguration' :: Maybe [RollbackTrigger]
rollbackTriggers = Maybe [RollbackTrigger]
a} :: RollbackConfiguration) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Data.FromXML RollbackConfiguration where
  parseXML :: [Node] -> Either String RollbackConfiguration
parseXML [Node]
x =
    Maybe Natural -> Maybe [RollbackTrigger] -> RollbackConfiguration
RollbackConfiguration'
      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
"MonitoringTimeInMinutes")
      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
"RollbackTriggers"
                      forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                      forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"member")
                  )

instance Prelude.Hashable RollbackConfiguration where
  hashWithSalt :: Int -> RollbackConfiguration -> Int
hashWithSalt Int
_salt RollbackConfiguration' {Maybe Natural
Maybe [RollbackTrigger]
rollbackTriggers :: Maybe [RollbackTrigger]
monitoringTimeInMinutes :: Maybe Natural
$sel:rollbackTriggers:RollbackConfiguration' :: RollbackConfiguration -> Maybe [RollbackTrigger]
$sel:monitoringTimeInMinutes:RollbackConfiguration' :: RollbackConfiguration -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
monitoringTimeInMinutes
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [RollbackTrigger]
rollbackTriggers

instance Prelude.NFData RollbackConfiguration where
  rnf :: RollbackConfiguration -> ()
rnf RollbackConfiguration' {Maybe Natural
Maybe [RollbackTrigger]
rollbackTriggers :: Maybe [RollbackTrigger]
monitoringTimeInMinutes :: Maybe Natural
$sel:rollbackTriggers:RollbackConfiguration' :: RollbackConfiguration -> Maybe [RollbackTrigger]
$sel:monitoringTimeInMinutes:RollbackConfiguration' :: RollbackConfiguration -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
monitoringTimeInMinutes
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [RollbackTrigger]
rollbackTriggers

instance Data.ToQuery RollbackConfiguration where
  toQuery :: RollbackConfiguration -> QueryString
toQuery RollbackConfiguration' {Maybe Natural
Maybe [RollbackTrigger]
rollbackTriggers :: Maybe [RollbackTrigger]
monitoringTimeInMinutes :: Maybe Natural
$sel:rollbackTriggers:RollbackConfiguration' :: RollbackConfiguration -> Maybe [RollbackTrigger]
$sel:monitoringTimeInMinutes:RollbackConfiguration' :: RollbackConfiguration -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"MonitoringTimeInMinutes"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Natural
monitoringTimeInMinutes,
        ByteString
"RollbackTriggers"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a. ToQuery a => a -> QueryString
Data.toQuery
            ( forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"member"
                forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [RollbackTrigger]
rollbackTriggers
            )
      ]