Package software.amazon.awssdk.services.cloudformation.model

Class StackSetOperationPreferences

java.lang.Object

software.amazon.awssdk.services.cloudformation.model.StackSetOperationPreferences

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StackSetOperationPreferences.Builder,StackSetOperationPreferences>

@Generated("software.amazon.awssdk:codegen")
public final class StackSetOperationPreferences
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StackSetOperationPreferences.Builder

Method Summary

Modifier and Type	Method	Description
static StackSetOperationPreferences.Builder	builder()
ConcurrencyMode	concurrencyMode()	Specifies how the concurrency level behaves during the operation execution.
String	concurrencyModeAsString()	Specifies how the concurrency level behaves during the operation execution.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	failureToleranceCount()	The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region.
Integer	failureTolerancePercentage()	The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRegionOrder()	For responses, this returns true if the service returned a value for the RegionOrder property.
Integer	maxConcurrentCount()	The maximum number of accounts in which to perform this operation at one time.
Integer	maxConcurrentPercentage()	The maximum percentage of accounts in which to perform this operation at one time.
RegionConcurrencyType	regionConcurrencyType()	The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
String	regionConcurrencyTypeAsString()	The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
List<String>	regionOrder()	The order of the Regions where you want to perform the stack operation.
List<SdkField<?>>	sdkFields()
static Class<? extends StackSetOperationPreferences.Builder>	serializableBuilderClass()
StackSetOperationPreferences.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

regionConcurrencyType

public final RegionConcurrencyType 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 return RegionConcurrencyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from regionConcurrencyTypeAsString().

Returns:

The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

See Also:

RegionConcurrencyType

regionConcurrencyTypeAsString

public final String 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 return RegionConcurrencyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from regionConcurrencyTypeAsString().

Returns:

The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.

See Also:

RegionConcurrencyType

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 the isEmpty() 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

public final List<String> regionOrder()

The order of the Regions where you want to perform the stack operation.

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.

failureToleranceCount

public final Integer 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 or FailureTolerancePercentage (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 or FailureTolerancePercentage (but not both).

By default, 0 is specified.

failureTolerancePercentage

public final Integer 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 or FailureTolerancePercentage, 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 or FailureTolerancePercentage, but not both.

By default, 0 is specified.

maxConcurrentCount

public final Integer 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 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.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, 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 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.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

maxConcurrentPercentage

public final Integer 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 or MaxConcurrentPercentage, 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 or MaxConcurrentPercentage, but not both.

By default, 1 is specified.

concurrencyMode

public final ConcurrencyMode 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 of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of MaxConcurrentCount +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 decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

If the service returns an enum value that is not available in the current SDK version, concurrencyMode will return ConcurrencyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from concurrencyModeAsString().

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 of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of MaxConcurrentCount +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 decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

See Also:

ConcurrencyMode

concurrencyModeAsString

public final String 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 of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of MaxConcurrentCount +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 decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

If the service returns an enum value that is not available in the current SDK version, concurrencyMode will return ConcurrencyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from concurrencyModeAsString().

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 of FailureToleranceCount +1. The initial actual concurrency is set to the lower of either the value of the MaxConcurrentCount, or the value of MaxConcurrentCount +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 decouples FailureToleranceCount from the actual concurrency. This allows stack set operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage, regardless of the number of failures.

See Also:

ConcurrencyMode

toBuilder

public StackSetOperationPreferences.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StackSetOperationPreferences.Builder,StackSetOperationPreferences>

builder

public static StackSetOperationPreferences.Builder builder()

serializableBuilderClass

public static Class<? extends StackSetOperationPreferences.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo