Class StackSetOperationPreferences
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StackSetOperationPreferences.Builder,
StackSetOperationPreferences>
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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final ConcurrencyMode
Specifies how the concurrency level behaves during the operation execution.final String
Specifies how the concurrency level behaves during the operation execution.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region.final Integer
The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RegionOrder property.final Integer
The maximum number of accounts in which to perform this operation at one time.final Integer
The maximum percentage of accounts in which to perform this operation at one time.final RegionConcurrencyType
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.final String
The 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.static Class
<? extends StackSetOperationPreferences.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
regionConcurrencyType
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
If the service returns an enum value that is not available in the current SDK version,
regionConcurrencyType
will returnRegionConcurrencyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromregionConcurrencyTypeAsString()
.- Returns:
- The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
- See Also:
-
regionConcurrencyTypeAsString
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
If the service returns an enum value that is not available in the current SDK version,
regionConcurrencyType
will returnRegionConcurrencyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromregionConcurrencyTypeAsString()
.- Returns:
- The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
- See Also:
-
hasRegionOrder
public final boolean hasRegionOrder()For responses, this returns true if the service returned a value for the RegionOrder property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
regionOrder
The order of the Regions where you want to perform the stack operation.
RegionOrder
isn't followed ifAutoDeployment
is enabled.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRegionOrder()
method.- Returns:
- The order of the Regions where you want to perform the stack operation.
RegionOrder
isn't followed ifAutoDeployment
is enabled.
-
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
FailureToleranceCount
orFailureTolerancePercentage
(but not both).By default,
0
is specified.- Returns:
- 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
orFailureTolerancePercentage
(but not both).By default,
0
is specified.
-
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
FailureToleranceCount
orFailureTolerancePercentage
, but not both.By default,
0
is specified.- Returns:
- 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
orFailureTolerancePercentage
, but not both.By default,
0
is specified.
-
maxConcurrentCount
The maximum number of accounts in which to perform this operation at one time. This can depend on the value of
FailureToleranceCount
depending on yourConcurrencyMode
.MaxConcurrentCount
is at most one more than theFailureToleranceCount
if 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
MaxConcurrentCount
orMaxConcurrentPercentage
, but not both.By default,
1
is specified.- Returns:
- The maximum number of accounts in which to perform this operation at one time. This can depend on the
value of
FailureToleranceCount
depending on yourConcurrencyMode
.MaxConcurrentCount
is at most one more than theFailureToleranceCount
if 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
MaxConcurrentCount
orMaxConcurrentPercentage
, but not both.By default,
1
is specified.
-
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
MaxConcurrentCount
orMaxConcurrentPercentage
, but not both.By default,
1
is specified.- Returns:
- 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
orMaxConcurrentPercentage
, but not both.By default,
1
is specified.
-
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 ofMaxConcurrentCount
+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.
If the service returns an enum value that is not available in the current SDK version,
concurrencyMode
will returnConcurrencyMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconcurrencyModeAsString()
.- Returns:
- 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 ofMaxConcurrentCount
+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.
-
- See Also:
-
-
concurrencyModeAsString
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 ofMaxConcurrentCount
+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.
If the service returns an enum value that is not available in the current SDK version,
concurrencyMode
will returnConcurrencyMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconcurrencyModeAsString()
.- Returns:
- 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 ofMaxConcurrentCount
+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.
-
- See Also:
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<StackSetOperationPreferences.Builder,
StackSetOperationPreferences> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-