Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudFormation.Types.RollbackConfiguration

Description

Documentation

data RollbackConfiguration Source #

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 Monitor and Roll Back Stack Operations.

See: newRollbackConfiguration smart constructor.

Constructors

RollbackConfiguration'

Fields

monitoringTimeInMinutes :: Maybe Natural
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 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 :: Maybe [RollbackTrigger]
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.

Instances

Instances details

ToQuery RollbackConfiguration Source #
Instance details Defined in Amazonka.CloudFormation.Types.RollbackConfiguration Methods toQuery :: RollbackConfiguration -> QueryString #
FromXML RollbackConfiguration Source #
Instance details Defined in Amazonka.CloudFormation.Types.RollbackConfiguration Methods parseXML :: [Node] -> Either String RollbackConfiguration #
Generic RollbackConfiguration Source #
Instance details Defined in Amazonka.CloudFormation.Types.RollbackConfiguration Associated Types type Rep RollbackConfiguration :: Type -> Type # Methods from :: RollbackConfiguration -> Rep RollbackConfiguration x # to :: Rep RollbackConfiguration x -> RollbackConfiguration #
Read RollbackConfiguration Source #
Instance details Defined in Amazonka.CloudFormation.Types.RollbackConfiguration Methods readsPrec :: Int -> ReadS RollbackConfiguration # readList :: ReadS [RollbackConfiguration] # readPrec :: ReadPrec RollbackConfiguration # readListPrec :: ReadPrec [RollbackConfiguration] #
Show RollbackConfiguration Source #
Instance details Defined in Amazonka.CloudFormation.Types.RollbackConfiguration Methods showsPrec :: Int -> RollbackConfiguration -> ShowS # show :: RollbackConfiguration -> String # showList :: [RollbackConfiguration] -> ShowS #
NFData RollbackConfiguration Source #
Instance details Defined in Amazonka.CloudFormation.Types.RollbackConfiguration Methods rnf :: RollbackConfiguration -> () #
Eq RollbackConfiguration Source #
Instance details Defined in Amazonka.CloudFormation.Types.RollbackConfiguration Methods (==) :: RollbackConfiguration -> RollbackConfiguration -> Bool # (/=) :: RollbackConfiguration -> RollbackConfiguration -> Bool #
Hashable RollbackConfiguration Source #
Instance details Defined in Amazonka.CloudFormation.Types.RollbackConfiguration Methods hashWithSalt :: Int -> RollbackConfiguration -> Int # hash :: RollbackConfiguration -> Int #
type Rep RollbackConfiguration Source #
Instance details Defined in Amazonka.CloudFormation.Types.RollbackConfiguration type Rep RollbackConfiguration = D1 ('MetaData "RollbackConfiguration" "Amazonka.CloudFormation.Types.RollbackConfiguration" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "RollbackConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "monitoringTimeInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "rollbackTriggers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RollbackTrigger]))))

newRollbackConfiguration :: RollbackConfiguration Source #

Create a value of RollbackConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:monitoringTimeInMinutes:RollbackConfiguration', 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 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.

$sel:rollbackTriggers:RollbackConfiguration', 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.

rollbackConfiguration_monitoringTimeInMinutes :: Lens' RollbackConfiguration (Maybe Natural) Source #

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 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_rollbackTriggers :: Lens' RollbackConfiguration (Maybe [RollbackTrigger]) Source #

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.