class Aws::CloudFormation::Types::StackSetOperationPreferences
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].
[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options
@note When making an API call, you may pass StackSetOperationPreferences
data as a hash: { region_concurrency_type: "SEQUENTIAL", # accepts SEQUENTIAL, PARALLEL region_order: ["Region"], failure_tolerance_count: 1, failure_tolerance_percentage: 1, max_concurrent_count: 1, max_concurrent_percentage: 1, }
@!attribute [rw] region_concurrency_type
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time. @return [String]
@!attribute [rw] region_order
The order of the Regions in where you want to perform the stack operation. @return [Array<String>]
@!attribute [rw] failure_tolerance_count
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. @return [Integer]
@!attribute [rw] failure_tolerance_percentage
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. @return [Integer]
@!attribute [rw] max_concurrent_count
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. @return [Integer]
@!attribute [rw] max_concurrent_percentage
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. @return [Integer]
@see docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/StackSetOperationPreferences AWS API Documentation
Constants
- SENSITIVE