Package software.amazon.awscdk.services.cloudformation

Class CfnStackSet.OperationPreferencesProperty.Builder

java.lang.Object

software.amazon.awscdk.services.cloudformation.CfnStackSet.OperationPreferencesProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnStackSet.OperationPreferencesProperty

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

A builder for CfnStackSet.OperationPreferencesProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnStackSet.OperationPreferencesProperty	build()	Builds the configured instance.
CfnStackSet.OperationPreferencesProperty.Builder	failureToleranceCount(Number failureToleranceCount)	Sets the value of CfnStackSet.OperationPreferencesProperty.getFailureToleranceCount()
CfnStackSet.OperationPreferencesProperty.Builder	failureTolerancePercentage(Number failureTolerancePercentage)	Sets the value of CfnStackSet.OperationPreferencesProperty.getFailureTolerancePercentage()
CfnStackSet.OperationPreferencesProperty.Builder	maxConcurrentCount(Number maxConcurrentCount)	Sets the value of CfnStackSet.OperationPreferencesProperty.getMaxConcurrentCount()
CfnStackSet.OperationPreferencesProperty.Builder	maxConcurrentPercentage(Number maxConcurrentPercentage)	Sets the value of CfnStackSet.OperationPreferencesProperty.getMaxConcurrentPercentage()
CfnStackSet.OperationPreferencesProperty.Builder	regionConcurrencyType(String regionConcurrencyType)	Sets the value of CfnStackSet.OperationPreferencesProperty.getRegionConcurrencyType()
CfnStackSet.OperationPreferencesProperty.Builder	regionOrder(List<String> regionOrder)	Sets the value of CfnStackSet.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

failureToleranceCount

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

Sets the value of CfnStackSet.OperationPreferencesProperty.getFailureToleranceCount()

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:

this

failureTolerancePercentage

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

Sets the value of CfnStackSet.OperationPreferencesProperty.getFailureTolerancePercentage()

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:

this

maxConcurrentCount

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

Sets the value of CfnStackSet.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 CfnStackSet.OperationPreferencesProperty.Builder maxConcurrentPercentage(Number maxConcurrentPercentage)

Sets the value of CfnStackSet.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, 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:

this

regionConcurrencyType

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

Sets the value of CfnStackSet.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 CfnStackSet.OperationPreferencesProperty.Builder regionOrder(List<String> regionOrder)

Sets the value of CfnStackSet.OperationPreferencesProperty.getRegionOrder()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnStackSet.OperationPreferencesProperty

Throws:

NullPointerException - if any required attribute was not provided