Interface CfnStackSetPropsMixin.OperationPreferencesProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnStackSetPropsMixin.OperationPreferencesProperty.Jsii$Proxy
- Enclosing class:
CfnStackSetPropsMixin
For more information on maximum concurrent accounts and failure tolerance, see StackSet operation options in the CloudFormation User Guide .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cfnpropertymixins.services.cloudformation.*;
OperationPreferencesProperty operationPreferencesProperty = OperationPreferencesProperty.builder()
.concurrencyMode("concurrencyMode")
.failureToleranceCount(123)
.failureTolerancePercentage(123)
.maxConcurrentCount(123)
.maxConcurrentPercentage(123)
.regionConcurrencyType("regionConcurrencyType")
.regionOrder(List.of("regionOrder"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnStackSetPropsMixin.OperationPreferencesPropertystatic final classAn implementation forCfnStackSetPropsMixin.OperationPreferencesProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringSpecifies how the concurrency level behaves during the operation execution.default NumberThe number of accounts per Region this operation can fail in before CloudFormation stops the operation in that Region.default NumberThe percentage of accounts per Region this stack operation can fail in before CloudFormation stops the operation in that Region.default NumberThe maximum number of accounts in which to perform this operation at one time.default NumberThe maximum percentage of accounts in which to perform this operation at one time.default StringThe concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.The order of the Regions where you want to perform the stack operation.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getConcurrencyMode
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.
- See Also:
-
getFailureToleranceCount
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.
Conditional: You must specify either
FailureToleranceCountorFailureTolerancePercentage(but not both).- See Also:
-
getFailureTolerancePercentage
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.
Conditional: You must specify either
FailureToleranceCountorFailureTolerancePercentage, but not both.- See Also:
-
getMaxConcurrentCount
The maximum number of accounts in which to perform this operation at one time.This is dependent on the value of
FailureToleranceCount.MaxConcurrentCountis at most one more than theFailureToleranceCount.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.- See Also:
-
getMaxConcurrentPercentage
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.- See Also:
-
getRegionConcurrencyType
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.- See Also:
-
getRegionOrder
The order of the Regions where you want to perform the stack operation.- See Also:
-
builder
-