software.amazon.awssdk.services.cloudformation.model

Interface StackSetOperationPreferences.Builder

All Superinterfaces:

Buildable, CopyableBuilder<StackSetOperationPreferences.Builder,StackSetOperationPreferences>, SdkBuilder<StackSetOperationPreferences.Builder,StackSetOperationPreferences>, SdkPojo

Enclosing class:

StackSetOperationPreferences

public static interface StackSetOperationPreferences.Builder
extends SdkPojo, CopyableBuilder<StackSetOperationPreferences.Builder,StackSetOperationPreferences>

Method Summary

Modifier and Type	Method and Description
StackSetOperationPreferences.Builder	failureToleranceCount(Integer failureToleranceCount) The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region.
StackSetOperationPreferences.Builder	failureTolerancePercentage(Integer failureTolerancePercentage) The percentage of accounts, per Region, for which this stack operation can fail before CloudFormation stops the operation in that Region.
StackSetOperationPreferences.Builder	maxConcurrentCount(Integer maxConcurrentCount) The maximum number of accounts in which to perform this operation at one time.
StackSetOperationPreferences.Builder	maxConcurrentPercentage(Integer maxConcurrentPercentage) The maximum percentage of accounts in which to perform this operation at one time.
StackSetOperationPreferences.Builder	regionConcurrencyType(RegionConcurrencyType regionConcurrencyType) The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
StackSetOperationPreferences.Builder	regionConcurrencyType(String regionConcurrencyType) The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
StackSetOperationPreferences.Builder	regionOrder(Collection<String> regionOrder) The order of the Regions in where you want to perform the stack operation.
StackSetOperationPreferences.Builder	regionOrder(String... regionOrder) The order of the Regions in where you want to perform the stack operation.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

regionConcurrencyType

StackSetOperationPreferences.Builder regionConcurrencyType(String regionConcurrencyType)

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

Parameters:

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

Returns:

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

See Also:

RegionConcurrencyType, RegionConcurrencyType

regionConcurrencyType

StackSetOperationPreferences.Builder regionConcurrencyType(RegionConcurrencyType regionConcurrencyType)

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

Parameters:

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

Returns:

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

See Also:

RegionConcurrencyType, RegionConcurrencyType

regionOrder

StackSetOperationPreferences.Builder regionOrder(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.

regionOrder

StackSetOperationPreferences.Builder regionOrder(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.

failureToleranceCount

StackSetOperationPreferences.Builder failureToleranceCount(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.

Parameters:

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:

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

failureTolerancePercentage

StackSetOperationPreferences.Builder failureTolerancePercentage(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.

Parameters:

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:

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

maxConcurrentCount

StackSetOperationPreferences.Builder maxConcurrentCount(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.

By default, 1 is specified.

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.

By default, 1 is specified.

Returns:

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

maxConcurrentPercentage

StackSetOperationPreferences.Builder maxConcurrentPercentage(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.

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, 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:

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