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.
Note
StackSetOperationPreferences don't apply to AutoDeployment, even if it's enabled.
Contents
- ConcurrencyMode
-
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 decouplesFailureToleranceCountfrom the actual concurrency. This allows stack set operations to run at the concurrency level set by theMaxConcurrentCountvalue, orMaxConcurrentPercentage, regardless of the number of failures.
Type: String
Valid Values:
STRICT_FAILURE_TOLERANCE | SOFT_FAILURE_TOLERANCERequired: No
-
- FailureToleranceCount
-
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
FailureToleranceCountorFailureTolerancePercentage(but not both).By default,
0is specified.Type: Integer
Valid Range: Minimum value of 0.
Required: No
- FailureTolerancePercentage
-
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
FailureToleranceCountorFailureTolerancePercentage, but not both.By default,
0is specified.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- MaxConcurrentCount
-
The maximum number of accounts in which to perform this operation at one time. This can depend on the value of
FailureToleranceCountdepending on yourConcurrencyMode.MaxConcurrentCountis at most one more than theFailureToleranceCountif you're usingSTRICT_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
MaxConcurrentCountorMaxConcurrentPercentage, but not both.By default,
1is specified.Type: Integer
Valid Range: Minimum value of 1.
Required: No
- MaxConcurrentPercentage
-
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
MaxConcurrentCountorMaxConcurrentPercentage, but not both.By default,
1is specified.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- RegionConcurrencyType
-
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
Type: String
Valid Values:
SEQUENTIAL | PARALLELRequired: No
- RegionOrder.member.N
-
The order of the Regions where you want to perform the stack operation.
Type: Array of strings
Pattern:
^[a-zA-Z0-9-]{1,128}$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
