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

The user-specified preferences for how AWS CloudFormation performs a stack set operation.

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StackSetOperationPreferences.Builder

Method Summary

Modifier and Type	Method and Description
static StackSetOperationPreferences.Builder	builder()
boolean	equals(Object obj)
Integer	failureToleranceCount() The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region.
Integer	failureTolerancePercentage() The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
List<String>	regionOrder() The order of the regions in where you want to perform the stack operation.
List<SdkField<?>>	sdkFields()
static Class<? extends StackSetOperationPreferences.Builder>	serializableBuilderClass()
StackSetOperationPreferences.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

regionOrder

public List<String> regionOrder()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

failureToleranceCount

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

Returns:

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

failureTolerancePercentage

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

Returns:

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

maxConcurrentCount

public Integer maxConcurrentCount()

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount .

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.

Returns:

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount .

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.

maxConcurrentPercentage

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

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

toBuilder

public StackSetOperationPreferences.Builder 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 interface ToCopyableBuilder<StackSetOperationPreferences.Builder,StackSetOperationPreferences>

Returns:

a builder for type T

builder

public static StackSetOperationPreferences.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.