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

#include <StackSetOperationPreferences.h>

Public Member Functions

 StackSetOperationPreferences ()
 
 StackSetOperationPreferences (const Aws::Utils::Xml::XmlNode &xmlNode)
 
StackSetOperationPreferencesoperator= (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 RegionConcurrencyTypeGetRegionConcurrencyType () const
 
bool RegionConcurrencyTypeHasBeenSet () const
 
void SetRegionConcurrencyType (const RegionConcurrencyType &value)
 
void SetRegionConcurrencyType (RegionConcurrencyType &&value)
 
StackSetOperationPreferencesWithRegionConcurrencyType (const RegionConcurrencyType &value)
 
StackSetOperationPreferencesWithRegionConcurrencyType (RegionConcurrencyType &&value)
 
const Aws::Vector< Aws::String > & GetRegionOrder () const
 
bool RegionOrderHasBeenSet () const
 
void SetRegionOrder (const Aws::Vector< Aws::String > &value)
 
void SetRegionOrder (Aws::Vector< Aws::String > &&value)
 
StackSetOperationPreferencesWithRegionOrder (const Aws::Vector< Aws::String > &value)
 
StackSetOperationPreferencesWithRegionOrder (Aws::Vector< Aws::String > &&value)
 
StackSetOperationPreferencesAddRegionOrder (const Aws::String &value)
 
StackSetOperationPreferencesAddRegionOrder (Aws::String &&value)
 
StackSetOperationPreferencesAddRegionOrder (const char *value)
 
int GetFailureToleranceCount () const
 
bool FailureToleranceCountHasBeenSet () const
 
void SetFailureToleranceCount (int value)
 
StackSetOperationPreferencesWithFailureToleranceCount (int value)
 
int GetFailureTolerancePercentage () const
 
bool FailureTolerancePercentageHasBeenSet () const
 
void SetFailureTolerancePercentage (int value)
 
StackSetOperationPreferencesWithFailureTolerancePercentage (int value)
 
int GetMaxConcurrentCount () const
 
bool MaxConcurrentCountHasBeenSet () const
 
void SetMaxConcurrentCount (int value)
 
StackSetOperationPreferencesWithMaxConcurrentCount (int value)
 
int GetMaxConcurrentPercentage () const
 
bool MaxConcurrentPercentageHasBeenSet () const
 
void SetMaxConcurrentPercentage (int value)
 
StackSetOperationPreferencesWithMaxConcurrentPercentage (int value)
 

Detailed Description

The user-specified preferences for how CloudFormation performs a stack set operation.

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.

See Also:

AWS API Reference

Definition at line 37 of file StackSetOperationPreferences.h.

Constructor & Destructor Documentation

◆ StackSetOperationPreferences() [1/2]

Aws::CloudFormation::Model::StackSetOperationPreferences::StackSetOperationPreferences ( )

◆ StackSetOperationPreferences() [2/2]

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

Member Function Documentation

◆ AddRegionOrder() [1/3]

StackSetOperationPreferences& Aws::CloudFormation::Model::StackSetOperationPreferences::AddRegionOrder ( Aws::String &&  value)
inline

The order of the Regions in where you want to perform the stack operation.

Definition at line 131 of file StackSetOperationPreferences.h.

◆ AddRegionOrder() [2/3]

StackSetOperationPreferences& Aws::CloudFormation::Model::StackSetOperationPreferences::AddRegionOrder ( const Aws::String value)
inline

The order of the Regions in where you want to perform the stack operation.

Definition at line 125 of file StackSetOperationPreferences.h.

◆ AddRegionOrder() [3/3]

StackSetOperationPreferences& Aws::CloudFormation::Model::StackSetOperationPreferences::AddRegionOrder ( const char *  value)
inline

The order of the Regions in where you want to perform the stack operation.

Definition at line 137 of file StackSetOperationPreferences.h.

◆ FailureToleranceCountHasBeenSet()

bool Aws::CloudFormation::Model::StackSetOperationPreferences::FailureToleranceCountHasBeenSet ( ) const
inline

The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

By default, 0 is specified.

Definition at line 158 of file StackSetOperationPreferences.h.

◆ FailureTolerancePercentageHasBeenSet()

bool Aws::CloudFormation::Model::StackSetOperationPreferences::FailureTolerancePercentageHasBeenSet ( ) const
inline

The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

By default, 0 is specified.

Definition at line 203 of file StackSetOperationPreferences.h.

◆ GetFailureToleranceCount()

int Aws::CloudFormation::Model::StackSetOperationPreferences::GetFailureToleranceCount ( ) const
inline

The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

By default, 0 is specified.

Definition at line 148 of file StackSetOperationPreferences.h.

◆ GetFailureTolerancePercentage()

int Aws::CloudFormation::Model::StackSetOperationPreferences::GetFailureTolerancePercentage ( ) const
inline

The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

By default, 0 is specified.

Definition at line 191 of file StackSetOperationPreferences.h.

◆ GetMaxConcurrentCount()

int Aws::CloudFormation::Model::StackSetOperationPreferences::GetMaxConcurrentCount ( ) const
inline

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

Definition at line 241 of file StackSetOperationPreferences.h.

◆ GetMaxConcurrentPercentage()

int Aws::CloudFormation::Model::StackSetOperationPreferences::GetMaxConcurrentPercentage ( ) const
inline

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

Definition at line 295 of file StackSetOperationPreferences.h.

◆ GetRegionConcurrencyType()

const RegionConcurrencyType& Aws::CloudFormation::Model::StackSetOperationPreferences::GetRegionConcurrencyType ( ) const
inline

The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

Definition at line 52 of file StackSetOperationPreferences.h.

◆ GetRegionOrder()

const Aws::Vector<Aws::String>& Aws::CloudFormation::Model::StackSetOperationPreferences::GetRegionOrder ( ) const
inline

The order of the Regions in where you want to perform the stack operation.

Definition at line 89 of file StackSetOperationPreferences.h.

◆ MaxConcurrentCountHasBeenSet()

bool Aws::CloudFormation::Model::StackSetOperationPreferences::MaxConcurrentCountHasBeenSet ( ) const
inline

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

Definition at line 254 of file StackSetOperationPreferences.h.

◆ MaxConcurrentPercentageHasBeenSet()

bool Aws::CloudFormation::Model::StackSetOperationPreferences::MaxConcurrentPercentageHasBeenSet ( ) const
inline

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

Definition at line 309 of file StackSetOperationPreferences.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ RegionConcurrencyTypeHasBeenSet()

bool Aws::CloudFormation::Model::StackSetOperationPreferences::RegionConcurrencyTypeHasBeenSet ( ) const
inline

The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

Definition at line 58 of file StackSetOperationPreferences.h.

◆ RegionOrderHasBeenSet()

bool Aws::CloudFormation::Model::StackSetOperationPreferences::RegionOrderHasBeenSet ( ) const
inline

The order of the Regions in where you want to perform the stack operation.

Definition at line 95 of file StackSetOperationPreferences.h.

◆ SetFailureToleranceCount()

void Aws::CloudFormation::Model::StackSetOperationPreferences::SetFailureToleranceCount ( int  value)
inline

The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

By default, 0 is specified.

Definition at line 168 of file StackSetOperationPreferences.h.

◆ SetFailureTolerancePercentage()

void Aws::CloudFormation::Model::StackSetOperationPreferences::SetFailureTolerancePercentage ( int  value)
inline

The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

By default, 0 is specified.

Definition at line 215 of file StackSetOperationPreferences.h.

◆ SetMaxConcurrentCount()

void Aws::CloudFormation::Model::StackSetOperationPreferences::SetMaxConcurrentCount ( int  value)
inline

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

Definition at line 267 of file StackSetOperationPreferences.h.

◆ SetMaxConcurrentPercentage()

void Aws::CloudFormation::Model::StackSetOperationPreferences::SetMaxConcurrentPercentage ( int  value)
inline

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

Definition at line 323 of file StackSetOperationPreferences.h.

◆ SetRegionConcurrencyType() [1/2]

void Aws::CloudFormation::Model::StackSetOperationPreferences::SetRegionConcurrencyType ( const RegionConcurrencyType value)
inline

The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

Definition at line 64 of file StackSetOperationPreferences.h.

◆ SetRegionConcurrencyType() [2/2]

void Aws::CloudFormation::Model::StackSetOperationPreferences::SetRegionConcurrencyType ( RegionConcurrencyType &&  value)
inline

The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

Definition at line 70 of file StackSetOperationPreferences.h.

◆ SetRegionOrder() [1/2]

void Aws::CloudFormation::Model::StackSetOperationPreferences::SetRegionOrder ( Aws::Vector< Aws::String > &&  value)
inline

The order of the Regions in where you want to perform the stack operation.

Definition at line 107 of file StackSetOperationPreferences.h.

◆ SetRegionOrder() [2/2]

void Aws::CloudFormation::Model::StackSetOperationPreferences::SetRegionOrder ( const Aws::Vector< Aws::String > &  value)
inline

The order of the Regions in where you want to perform the stack operation.

Definition at line 101 of file StackSetOperationPreferences.h.

◆ WithFailureToleranceCount()

StackSetOperationPreferences& Aws::CloudFormation::Model::StackSetOperationPreferences::WithFailureToleranceCount ( int  value)
inline

The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

By default, 0 is specified.

Definition at line 178 of file StackSetOperationPreferences.h.

◆ WithFailureTolerancePercentage()

StackSetOperationPreferences& Aws::CloudFormation::Model::StackSetOperationPreferences::WithFailureTolerancePercentage ( int  value)
inline

The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

By default, 0 is specified.

Definition at line 227 of file StackSetOperationPreferences.h.

◆ WithMaxConcurrentCount()

StackSetOperationPreferences& Aws::CloudFormation::Model::StackSetOperationPreferences::WithMaxConcurrentCount ( int  value)
inline

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount. MaxConcurrentCount is at most one more than the FailureToleranceCount.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

Definition at line 280 of file StackSetOperationPreferences.h.

◆ WithMaxConcurrentPercentage()

StackSetOperationPreferences& Aws::CloudFormation::Model::StackSetOperationPreferences::WithMaxConcurrentPercentage ( int  value)
inline

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

Definition at line 337 of file StackSetOperationPreferences.h.

◆ WithRegionConcurrencyType() [1/2]

StackSetOperationPreferences& Aws::CloudFormation::Model::StackSetOperationPreferences::WithRegionConcurrencyType ( const RegionConcurrencyType value)
inline

The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

Definition at line 76 of file StackSetOperationPreferences.h.

◆ WithRegionConcurrencyType() [2/2]

StackSetOperationPreferences& Aws::CloudFormation::Model::StackSetOperationPreferences::WithRegionConcurrencyType ( RegionConcurrencyType &&  value)
inline

The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

Definition at line 82 of file StackSetOperationPreferences.h.

◆ WithRegionOrder() [1/2]

StackSetOperationPreferences& Aws::CloudFormation::Model::StackSetOperationPreferences::WithRegionOrder ( Aws::Vector< Aws::String > &&  value)
inline

The order of the Regions in where you want to perform the stack operation.

Definition at line 119 of file StackSetOperationPreferences.h.

◆ WithRegionOrder() [2/2]

StackSetOperationPreferences& Aws::CloudFormation::Model::StackSetOperationPreferences::WithRegionOrder ( const Aws::Vector< Aws::String > &  value)
inline

The order of the Regions in where you want to perform the stack operation.

Definition at line 113 of file StackSetOperationPreferences.h.


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