You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CloudFormation::Types::StackSetOperationPreferences
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::StackSetOperationPreferences
- Defined in:
- (unknown)
Overview
When passing StackSetOperationPreferences as input to an Aws::Client method, you can use a vanilla Hash:
{
region_order: ["Region"],
failure_tolerance_count: 1,
failure_tolerance_percentage: 1,
max_concurrent_count: 1,
max_concurrent_percentage: 1,
}
The user-specified preferences for how AWS CloudFormation performs a stack set operation.
For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.
Returned by:
Instance Attribute Summary collapse
-
#failure_tolerance_count ⇒ Integer
The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region.
-
#failure_tolerance_percentage ⇒ Integer
The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.
-
#max_concurrent_count ⇒ Integer
The maximum number of accounts in which to perform this operation at one time.
-
#max_concurrent_percentage ⇒ Integer
The maximum percentage of accounts in which to perform this operation at one time.
-
#region_order ⇒ Array<String>
The order of the Regions in where you want to perform the stack operation.
Instance Attribute Details
#failure_tolerance_count ⇒ Integer
The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn\'t attempt the operation in any subsequent Regions.
Conditional: You must specify either FailureToleranceCount
or
FailureTolerancePercentage
(but not both).
#failure_tolerance_percentage ⇒ Integer
The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. If the operation is stopped in a Region, AWS CloudFormation doesn\'t attempt the operation in any subsequent Regions.
When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.
Conditional: You must specify either FailureToleranceCount
or
FailureTolerancePercentage
, but not both.
#max_concurrent_count ⇒ Integer
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.
#max_concurrent_percentage ⇒ Integer
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, AWS 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.
#region_order ⇒ Array<String>
The order of the Regions in where you want to perform the stack operation.