AWS SDK for C++  1.8.72
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudFormation::Model::RollbackConfiguration Class Reference

#include <RollbackConfiguration.h>

Public Member Functions

 RollbackConfiguration ()
 
 RollbackConfiguration (const Aws::Utils::Xml::XmlNode &xmlNode)
 
RollbackConfigurationoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::Vector< RollbackTrigger > & GetRollbackTriggers () const
 
bool RollbackTriggersHasBeenSet () const
 
void SetRollbackTriggers (const Aws::Vector< RollbackTrigger > &value)
 
void SetRollbackTriggers (Aws::Vector< RollbackTrigger > &&value)
 
RollbackConfigurationWithRollbackTriggers (const Aws::Vector< RollbackTrigger > &value)
 
RollbackConfigurationWithRollbackTriggers (Aws::Vector< RollbackTrigger > &&value)
 
RollbackConfigurationAddRollbackTriggers (const RollbackTrigger &value)
 
RollbackConfigurationAddRollbackTriggers (RollbackTrigger &&value)
 
int GetMonitoringTimeInMinutes () const
 
bool MonitoringTimeInMinutesHasBeenSet () const
 
void SetMonitoringTimeInMinutes (int value)
 
RollbackConfigurationWithMonitoringTimeInMinutes (int value)
 

Detailed Description

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 more information, see Monitor and Roll Back Stack Operations.

See Also:

AWS API Reference

Definition at line 39 of file RollbackConfiguration.h.

Constructor & Destructor Documentation

◆ RollbackConfiguration() [1/2]

Aws::CloudFormation::Model::RollbackConfiguration::RollbackConfiguration ( )

◆ RollbackConfiguration() [2/2]

Aws::CloudFormation::Model::RollbackConfiguration::RollbackConfiguration ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddRollbackTriggers() [1/2]

RollbackConfiguration& Aws::CloudFormation::Model::RollbackConfiguration::AddRollbackTriggers ( const RollbackTrigger value)
inline

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:

  • 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 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.

  • 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.

Definition at line 174 of file RollbackConfiguration.h.

◆ AddRollbackTriggers() [2/2]

RollbackConfiguration& Aws::CloudFormation::Model::RollbackConfiguration::AddRollbackTriggers ( RollbackTrigger &&  value)
inline

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:

  • 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 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.

  • 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.

Definition at line 192 of file RollbackConfiguration.h.

◆ GetMonitoringTimeInMinutes()

int Aws::CloudFormation::Model::RollbackConfiguration::GetMonitoringTimeInMinutes ( ) const
inline

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 do not 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.

Definition at line 210 of file RollbackConfiguration.h.

◆ GetRollbackTriggers()

const Aws::Vector<RollbackTrigger>& Aws::CloudFormation::Model::RollbackConfiguration::GetRollbackTriggers ( ) const
inline

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:

  • 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 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.

  • 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.

Definition at line 66 of file RollbackConfiguration.h.

◆ MonitoringTimeInMinutesHasBeenSet()

bool Aws::CloudFormation::Model::RollbackConfiguration::MonitoringTimeInMinutesHasBeenSet ( ) const
inline

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 do not 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.

Definition at line 227 of file RollbackConfiguration.h.

◆ operator=()

RollbackConfiguration& Aws::CloudFormation::Model::RollbackConfiguration::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::CloudFormation::Model::RollbackConfiguration::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::CloudFormation::Model::RollbackConfiguration::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ RollbackTriggersHasBeenSet()

bool Aws::CloudFormation::Model::RollbackConfiguration::RollbackTriggersHasBeenSet ( ) const
inline

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:

  • 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 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.

  • 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.

Definition at line 84 of file RollbackConfiguration.h.

◆ SetMonitoringTimeInMinutes()

void Aws::CloudFormation::Model::RollbackConfiguration::SetMonitoringTimeInMinutes ( int  value)
inline

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 do not 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.

Definition at line 244 of file RollbackConfiguration.h.

◆ SetRollbackTriggers() [1/2]

void Aws::CloudFormation::Model::RollbackConfiguration::SetRollbackTriggers ( const Aws::Vector< RollbackTrigger > &  value)
inline

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:

  • 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 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.

  • 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.

Definition at line 102 of file RollbackConfiguration.h.

◆ SetRollbackTriggers() [2/2]

void Aws::CloudFormation::Model::RollbackConfiguration::SetRollbackTriggers ( Aws::Vector< RollbackTrigger > &&  value)
inline

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:

  • 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 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.

  • 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.

Definition at line 120 of file RollbackConfiguration.h.

◆ WithMonitoringTimeInMinutes()

RollbackConfiguration& Aws::CloudFormation::Model::RollbackConfiguration::WithMonitoringTimeInMinutes ( int  value)
inline

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 do not 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.

Definition at line 261 of file RollbackConfiguration.h.

◆ WithRollbackTriggers() [1/2]

RollbackConfiguration& Aws::CloudFormation::Model::RollbackConfiguration::WithRollbackTriggers ( const Aws::Vector< RollbackTrigger > &  value)
inline

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:

  • 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 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.

  • 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.

Definition at line 138 of file RollbackConfiguration.h.

◆ WithRollbackTriggers() [2/2]

RollbackConfiguration& Aws::CloudFormation::Model::RollbackConfiguration::WithRollbackTriggers ( Aws::Vector< RollbackTrigger > &&  value)
inline

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:

  • 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 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.

  • 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.

Definition at line 156 of file RollbackConfiguration.h.


The documentation for this class was generated from the following file: