Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Class CfnStackSetPropsMixin.OperationPreferencesProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnStackSetPropsMixin.OperationPreferencesProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStackSetPropsMixin.OperationPreferencesProperty>

Enclosing interface:

CfnStackSetPropsMixin.OperationPreferencesProperty

@Stability(Stable)
public static final class CfnStackSetPropsMixin.OperationPreferencesProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStackSetPropsMixin.OperationPreferencesProperty>

A builder for CfnStackSetPropsMixin.OperationPreferencesProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnStackSetPropsMixin.OperationPreferencesProperty	build()	Builds the configured instance.
CfnStackSetPropsMixin.OperationPreferencesProperty.Builder	concurrencyMode(String concurrencyMode)	Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getConcurrencyMode()
CfnStackSetPropsMixin.OperationPreferencesProperty.Builder	failureToleranceCount(Number failureToleranceCount)	Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getFailureToleranceCount()
CfnStackSetPropsMixin.OperationPreferencesProperty.Builder	failureTolerancePercentage(Number failureTolerancePercentage)	Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getFailureTolerancePercentage()
CfnStackSetPropsMixin.OperationPreferencesProperty.Builder	maxConcurrentCount(Number maxConcurrentCount)	Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getMaxConcurrentCount()
CfnStackSetPropsMixin.OperationPreferencesProperty.Builder	maxConcurrentPercentage(Number maxConcurrentPercentage)	Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getMaxConcurrentPercentage()
CfnStackSetPropsMixin.OperationPreferencesProperty.Builder	regionConcurrencyType(String regionConcurrencyType)	Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getRegionConcurrencyType()
CfnStackSetPropsMixin.OperationPreferencesProperty.Builder	regionOrder(List<String> regionOrder)	Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getRegionOrder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

concurrencyMode

@Stability(Stable)
public CfnStackSetPropsMixin.OperationPreferencesProperty.Builder concurrencyMode(String concurrencyMode)

Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getConcurrencyMode()

Parameters:

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 FailureToleranceCount +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 StackSet operations to run at the concurrency level set by the MaxConcurrentCount value, or MaxConcurrentPercentage , regardless of the number of failures.

Returns:

this

failureToleranceCount

@Stability(Stable)
public CfnStackSetPropsMixin.OperationPreferencesProperty.Builder failureToleranceCount(Number failureToleranceCount)

Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getFailureToleranceCount()

Parameters:

failureToleranceCount - The number of accounts per Region this operation can fail in 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).

Returns:

this

failureTolerancePercentage

@Stability(Stable)
public CfnStackSetPropsMixin.OperationPreferencesProperty.Builder failureTolerancePercentage(Number failureTolerancePercentage)

Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getFailureTolerancePercentage()

Parameters:

failureTolerancePercentage - The percentage of accounts per Region this stack operation can fail in 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.

Returns:

this

maxConcurrentCount

@Stability(Stable)
public CfnStackSetPropsMixin.OperationPreferencesProperty.Builder maxConcurrentCount(Number maxConcurrentCount)

Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getMaxConcurrentCount()

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:

this

maxConcurrentPercentage

@Stability(Stable)
public CfnStackSetPropsMixin.OperationPreferencesProperty.Builder maxConcurrentPercentage(Number maxConcurrentPercentage)

Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getMaxConcurrentPercentage()

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.

Returns:

this

regionConcurrencyType

@Stability(Stable)
public CfnStackSetPropsMixin.OperationPreferencesProperty.Builder regionConcurrencyType(String regionConcurrencyType)

Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getRegionConcurrencyType()

Parameters:

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

Returns:

this

regionOrder

@Stability(Stable)
public CfnStackSetPropsMixin.OperationPreferencesProperty.Builder regionOrder(List<String> regionOrder)

Sets the value of CfnStackSetPropsMixin.OperationPreferencesProperty.getRegionOrder()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnStackSetPropsMixin.OperationPreferencesProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnStackSetPropsMixin.OperationPreferencesProperty>

Returns:

a new instance of CfnStackSetPropsMixin.OperationPreferencesProperty

Throws:

NullPointerException - if any required attribute was not provided