Class CfnStackSet.OperationPreferencesProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStackSet.OperationPreferencesProperty>
- Enclosing interface:
CfnStackSet.OperationPreferencesProperty
CfnStackSet.OperationPreferencesProperty
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.concurrencyMode
(String concurrencyMode) Sets the value ofCfnStackSet.OperationPreferencesProperty.getConcurrencyMode()
failureToleranceCount
(Number failureToleranceCount) Sets the value ofCfnStackSet.OperationPreferencesProperty.getFailureToleranceCount()
failureTolerancePercentage
(Number failureTolerancePercentage) Sets the value ofCfnStackSet.OperationPreferencesProperty.getFailureTolerancePercentage()
maxConcurrentCount
(Number maxConcurrentCount) Sets the value ofCfnStackSet.OperationPreferencesProperty.getMaxConcurrentCount()
maxConcurrentPercentage
(Number maxConcurrentPercentage) Sets the value ofCfnStackSet.OperationPreferencesProperty.getMaxConcurrentPercentage()
regionConcurrencyType
(String regionConcurrencyType) Sets the value ofCfnStackSet.OperationPreferencesProperty.getRegionConcurrencyType()
regionOrder
(List<String> regionOrder) Sets the value ofCfnStackSet.OperationPreferencesProperty.getRegionOrder()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
concurrencyMode
@Stability(Stable) public CfnStackSet.OperationPreferencesProperty.Builder concurrencyMode(String concurrencyMode) Sets the value ofCfnStackSet.OperationPreferencesProperty.getConcurrencyMode()
- Parameters:
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 decouplesFailureToleranceCount
from the actual concurrency. This allows stack set operations to run at the concurrency level set by theMaxConcurrentCount
value, orMaxConcurrentPercentage
, regardless of the number of failures.
- Returns:
this
-
failureToleranceCount
@Stability(Stable) public CfnStackSet.OperationPreferencesProperty.Builder failureToleranceCount(Number failureToleranceCount) Sets the value ofCfnStackSet.OperationPreferencesProperty.getFailureToleranceCount()
- Parameters:
failureToleranceCount
- 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
orFailureTolerancePercentage
(but not both).- Returns:
this
-
failureTolerancePercentage
@Stability(Stable) public CfnStackSet.OperationPreferencesProperty.Builder failureTolerancePercentage(Number failureTolerancePercentage) Sets the value ofCfnStackSet.OperationPreferencesProperty.getFailureTolerancePercentage()
- Parameters:
failureTolerancePercentage
- 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
orFailureTolerancePercentage
, but not both.- Returns:
this
-
maxConcurrentCount
@Stability(Stable) public CfnStackSet.OperationPreferencesProperty.Builder maxConcurrentCount(Number maxConcurrentCount) Sets the value ofCfnStackSet.OperationPreferencesProperty.getMaxConcurrentCount()
- Parameters:
maxConcurrentCount
- The maximum number of accounts in which to perform this operation at one time. This is dependent on the value ofFailureToleranceCount
.MaxConcurrentCount
is 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
MaxConcurrentCount
orMaxConcurrentPercentage
, but not both.- Returns:
this
-
maxConcurrentPercentage
@Stability(Stable) public CfnStackSet.OperationPreferencesProperty.Builder maxConcurrentPercentage(Number maxConcurrentPercentage) Sets the value ofCfnStackSet.OperationPreferencesProperty.getMaxConcurrentPercentage()
- Parameters:
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, 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
orMaxConcurrentPercentage
, but not both.- Returns:
this
-
regionConcurrencyType
@Stability(Stable) public CfnStackSet.OperationPreferencesProperty.Builder regionConcurrencyType(String regionConcurrencyType) Sets the value ofCfnStackSet.OperationPreferencesProperty.getRegionConcurrencyType()
- Parameters:
regionConcurrencyType
- The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.- Returns:
this
-
regionOrder
@Stability(Stable) public CfnStackSet.OperationPreferencesProperty.Builder regionOrder(List<String> regionOrder) Sets the value ofCfnStackSet.OperationPreferencesProperty.getRegionOrder()
- Parameters:
regionOrder
- The order of the Regions where you want to perform the stack operation.RegionOrder
isn't followed ifAutoDeployment
is enabled.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnStackSet.OperationPreferencesProperty>
- Returns:
- a new instance of
CfnStackSet.OperationPreferencesProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-