Class: Aws::CloudFormation::Types::StackSetOperationPreferences
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudFormation::Types::StackSetOperationPreferences
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-cloudformation/types.rb
Overview
When making an API call, you may pass StackSetOperationPreferences data as a 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].
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
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).
6206 6207 6208 6209 6210 6211 6212 6213 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6206 class StackSetOperationPreferences < Struct.new( :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage) include Aws::Structure end |
#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.
6206 6207 6208 6209 6210 6211 6212 6213 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6206 class StackSetOperationPreferences < Struct.new( :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage) include Aws::Structure end |
#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.
6206 6207 6208 6209 6210 6211 6212 6213 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6206 class StackSetOperationPreferences < Struct.new( :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage) 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, 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.
6206 6207 6208 6209 6210 6211 6212 6213 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6206 class StackSetOperationPreferences < Struct.new( :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage) include Aws::Structure end |
#region_order ⇒ Array<String>
The order of the regions in where you want to perform the stack operation.
6206 6207 6208 6209 6210 6211 6212 6213 |
# File 'lib/aws-sdk-cloudformation/types.rb', line 6206 class StackSetOperationPreferences < Struct.new( :region_order, :failure_tolerance_count, :failure_tolerance_percentage, :max_concurrent_count, :max_concurrent_percentage) include Aws::Structure end |