com.amazonaws.services.cloudformation.model

Class StackSetOperationPreferences

java.lang.Object

com.amazonaws.services.cloudformation.model.StackSetOperationPreferences

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StackSetOperationPreferences
extends Object
implements Serializable, Cloneable

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
StackSetOperationPreferences()

Method Summary

Modifier and Type	Method and Description
StackSetOperationPreferences	clone()
boolean	equals(Object obj)
Integer	getFailureToleranceCount() The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region.
Integer	getFailureTolerancePercentage() The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region.
Integer	getMaxConcurrentCount() The maximum number of accounts in which to perform this operation at one time.
Integer	getMaxConcurrentPercentage() The maximum percentage of accounts in which to perform this operation at one time.
List<String>	getRegionOrder() The order of the regions in where you want to perform the stack operation.
int	hashCode()
void	setFailureToleranceCount(Integer failureToleranceCount) The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region.
void	setFailureTolerancePercentage(Integer failureTolerancePercentage) The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region.
void	setMaxConcurrentCount(Integer maxConcurrentCount) The maximum number of accounts in which to perform this operation at one time.
void	setMaxConcurrentPercentage(Integer maxConcurrentPercentage) The maximum percentage of accounts in which to perform this operation at one time.
void	setRegionOrder(Collection<String> regionOrder) The order of the regions in where you want to perform the stack operation.
String	toString() Returns a string representation of this object; useful for testing and debugging.
StackSetOperationPreferences	withFailureToleranceCount(Integer failureToleranceCount) The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region.
StackSetOperationPreferences	withFailureTolerancePercentage(Integer failureTolerancePercentage) The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region.
StackSetOperationPreferences	withMaxConcurrentCount(Integer maxConcurrentCount) The maximum number of accounts in which to perform this operation at one time.
StackSetOperationPreferences	withMaxConcurrentPercentage(Integer maxConcurrentPercentage) The maximum percentage of accounts in which to perform this operation at one time.
StackSetOperationPreferences	withRegionOrder(Collection<String> regionOrder) The order of the regions in where you want to perform the stack operation.
StackSetOperationPreferences	withRegionOrder(String... regionOrder) The order of the regions in where you want to perform the stack operation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StackSetOperationPreferences

public StackSetOperationPreferences()

Method Detail

getRegionOrder

public List<String> getRegionOrder()

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

Returns:

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

setRegionOrder

public void setRegionOrder(Collection<String> regionOrder)

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

Parameters:

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

withRegionOrder

public StackSetOperationPreferences withRegionOrder(String... regionOrder)

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

NOTE: This method appends the values to the existing list (if any). Use setRegionOrder(java.util.Collection) or withRegionOrder(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withRegionOrder

public StackSetOperationPreferences withRegionOrder(Collection<String> regionOrder)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setFailureToleranceCount

public void setFailureToleranceCount(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).

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

getFailureToleranceCount

public Integer getFailureToleranceCount()

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).

withFailureToleranceCount

public StackSetOperationPreferences withFailureToleranceCount(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).

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setFailureTolerancePercentage

public void setFailureTolerancePercentage(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.

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

getFailureTolerancePercentage

public Integer getFailureTolerancePercentage()

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.

withFailureTolerancePercentage

public StackSetOperationPreferences withFailureTolerancePercentage(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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxConcurrentCount

public void setMaxConcurrentCount(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.

Parameters:

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.

getMaxConcurrentCount

public Integer getMaxConcurrentCount()

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.

withMaxConcurrentCount

public StackSetOperationPreferences withMaxConcurrentCount(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMaxConcurrentPercentage

public void setMaxConcurrentPercentage(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.

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

getMaxConcurrentPercentage

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

withMaxConcurrentPercentage

public StackSetOperationPreferences withMaxConcurrentPercentage(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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StackSetOperationPreferences clone()

Overrides:

clone in class Object