Class: Aws::CloudFormation::Types::StackSetOperationPreferences
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::StackSetOperationPreferences
- Defined in:
- gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb
Overview
The user-specified preferences for how CloudFormation performs a stack set operation.
For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#concurrency_mode ⇒ String
Specifies how the concurrency level behaves during the operation execution.
-
#failure_tolerance_count ⇒ Integer
The number of accounts, per Region, for which this operation can fail before 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 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_concurrency_type ⇒ String
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
-
#region_order ⇒ Array<String>
The order of the Regions where you want to perform the stack operation.
Instance Attribute Details
#concurrency_mode ⇒ String
Specifies how the concurrency level behaves during the operation execution.
STRICT_FAILURE_TOLERANCE
: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value ofFailureToleranceCount
+1. The initial actual concurrency is set to the lower of either the value of theMaxConcurrentCount
, or the value ofFailureToleranceCount
+1. The actual concurrency is then reduced proportionally by the number of failures. This is the default behavior.If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.
SOFT_FAILURE_TOLERANCE
: This option decouplesFailureToleranceCount
from the actual concurrency. This allows stack set operations to run at the concurrency level set by theMaxConcurrentCount
value, orMaxConcurrentPercentage
, regardless of the number of failures.
9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9382 class StackSetOperationPreferences < Struct.new( :region_concurrency_type, :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage, :concurrency_mode) SENSITIVE = [] include Aws::Structure end |
#failure_tolerance_count ⇒ Integer
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.
9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9382 class StackSetOperationPreferences < Struct.new( :region_concurrency_type, :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage, :concurrency_mode) SENSITIVE = [] include Aws::Structure end |
#failure_tolerance_percentage ⇒ Integer
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.
9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9382 class StackSetOperationPreferences < Struct.new( :region_concurrency_type, :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage, :concurrency_mode) SENSITIVE = [] include Aws::Structure end |
#max_concurrent_count ⇒ Integer
The maximum number of accounts in which to perform this operation at
one time. This can depend on the value of FailureToleranceCount
depending on your ConcurrencyMode
. MaxConcurrentCount
is at most
one more than the FailureToleranceCount
if you're using
STRICT_FAILURE_TOLERANCE
.
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.
9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9382 class StackSetOperationPreferences < Struct.new( :region_concurrency_type, :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage, :concurrency_mode) SENSITIVE = [] include Aws::Structure end |
#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, 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.
9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9382 class StackSetOperationPreferences < Struct.new( :region_concurrency_type, :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage, :concurrency_mode) SENSITIVE = [] include Aws::Structure end |
#region_concurrency_type ⇒ String
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9382 class StackSetOperationPreferences < Struct.new( :region_concurrency_type, :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage, :concurrency_mode) SENSITIVE = [] include Aws::Structure end |
#region_order ⇒ Array<String>
The order of the Regions where you want to perform the stack operation.
RegionOrder
isn't followed if AutoDeployment
is enabled.
9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 |
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 9382 class StackSetOperationPreferences < Struct.new( :region_concurrency_type, :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage, :concurrency_mode) SENSITIVE = [] include Aws::Structure end |