StackSetOperationPreferences¶
Structure Class¶
dataclass
¶
Bases: _SerdeShape
The user-specified preferences for how CloudFormation performs a StackSet operation.
For more information about maximum concurrent accounts and failure tolerance, see StackSet operation options.
Note
StackSetOperationPreferences don't apply to AutoDeployment, even if
it's enabled.
Attributes¶
class-attribute
instance-attribute
¶
concurrency_mode: str | None = ...
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 StackSet operations to run at the concurrency level set by theMaxConcurrentCountvalue, orMaxConcurrentPercentage, regardless of the number of failures.
class-attribute
instance-attribute
¶
failure_tolerance_count: int | None = ...
The number of accounts per Region this operation can fail in 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.
You can specify either FailureToleranceCount or
FailureTolerancePercentage, but not both.
By default, 0 is specified.
class-attribute
instance-attribute
¶
failure_tolerance_percentage: int | None = ...
The percentage of accounts per Region this stack operation can fail in 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.
You can specify either FailureToleranceCount or
FailureTolerancePercentage, but not both.
By default, 0 is specified.
class-attribute
instance-attribute
¶
max_concurrent_count: int | None = ...
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.
You can specify either MaxConcurrentCount or
MaxConcurrentPercentage, but not both.
By default, 1 is specified.
class-attribute
instance-attribute
¶
max_concurrent_percentage: int | None = ...
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.
You can specify either MaxConcurrentCount or
MaxConcurrentPercentage, but not both.
By default, 1 is specified.