Class: Aws::CloudFormation::Types::RollbackConfiguration

Inherits:

Struct

Object
Struct
Aws::CloudFormation::Types::RollbackConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass RollbackConfiguration data as a hash:

{
  rollback_triggers: [
    {
      arn: "Arn", # required
      type: "Type", # required
    },
  ],
  monitoring_time_in_minutes: 1,
}

Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Rollback triggers enable you to have AWS 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 each rollback trigger you create, you specify the Cloudwatch alarm that CloudFormation should monitor. CloudFormation monitors the specified alarms during the stack create or update operation, and for the specified amount of time after all resources have been deployed. If any of the alarms goes to ALERT state during the stack operation or the monitoring period, CloudFormation rolls back the entire stack operation. If the monitoring period expires without any alarms going to ALERT state, CloudFormation proceeds to dispose of old resources as usual.

By default, CloudFormation only rolls back stack operations if an alarm goes to ALERT state, not INSUFFICIENT_DATA state. To have CloudFormation roll back the stack operation if an alarm goes to INSUFFICIENT_DATA state as well, edit the CloudWatch alarm to treat missing data as ‘breaching`. For more information, see [Configuring How CloudWatch Alarms Treats Missing Data].

AWS CloudFormation does not monitor rollback triggers when it rolls back a stack during an update operation.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html

Instance Attribute Summary collapse

#monitoring_time_in_minutes ⇒ Integer

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.
#rollback_triggers ⇒ Array<Types::RollbackTrigger>

The triggers to monitor during stack creation or update actions.

Instance Attribute Details

#monitoring_time_in_minutes ⇒ `Integer`

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. If any of the alarms goes to ALERT state during the stack operation or this monitoring period, CloudFormation rolls back the entire stack operation. Then, for update operations, if the monitoring period expires without any alarms going to ALERT state CloudFormation proceeds to dispose of old resources as usual.

If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources for 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.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html

Returns:

(Integer)

# File 'lib/aws-sdk-cloudformation/types.rb', line 3136

class RollbackConfiguration < Struct.new(
  :rollback_triggers,
  :monitoring_time_in_minutes)
  include Aws::Structure
end

#rollback_triggers ⇒ `Array<Types::RollbackTrigger>`

The triggers to monitor during stack creation or update actions.

By default, AWS 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:

If you don’t specify this parameter, AWS CloudFormation uses the rollback triggers previously specified for this stack, if any.
If you specify any rollback triggers using this parameter, you must specify all the triggers that you want used for this stack, even triggers you’ve specifed 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.
If you specify an empty list, AWS CloudFormation removes all currently specified triggers.

If a specified Cloudwatch alarm is missing, the entire stack operation fails and is rolled back.