Package software.amazon.awscdk.services.cloudformation

Interface CfnStackSet.OperationPreferencesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStackSet.OperationPreferencesProperty.Jsii$Proxy

Enclosing class:

CfnStackSet

@Stability(Stable)
public static interface CfnStackSet.OperationPreferencesProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 OperationPreferencesProperty operationPreferencesProperty = OperationPreferencesProperty.builder()
         .failureToleranceCount(123)
         .failureTolerancePercentage(123)
         .maxConcurrentCount(123)
         .maxConcurrentPercentage(123)
         .regionConcurrencyType("regionConcurrencyType")
         .regionOrder(List.of("regionOrder"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStackSet.OperationPreferencesProperty.Builder	A builder for CfnStackSet.OperationPreferencesProperty
static final class	CfnStackSet.OperationPreferencesProperty.Jsii$Proxy	An implementation for CfnStackSet.OperationPreferencesProperty

Method Summary

Modifier and Type	Method	Description
static CfnStackSet.OperationPreferencesProperty.Builder	builder()
default Number	getFailureToleranceCount()	The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region.
default Number	getFailureTolerancePercentage()	The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.
default Number	getMaxConcurrentCount()	The maximum number of accounts in which to perform this operation at one time.
default Number	getMaxConcurrentPercentage()	The maximum percentage of accounts in which to perform this operation at one time.
default String	getRegionConcurrencyType()	The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
default List<String>	getRegionOrder()	The order of the Regions where you want to perform the stack operation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFailureToleranceCount

@Stability(Stable)
@Nullable
default Number 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).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancecount

getFailureTolerancePercentage

@Stability(Stable)
@Nullable
default Number 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-failuretolerancepercentage

getMaxConcurrentCount

@Stability(Stable)
@Nullable
default Number 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentcount

getMaxConcurrentPercentage

@Stability(Stable)
@Nullable
default Number 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-maxconcurrentpercentage

getRegionConcurrencyType

@Stability(Stable)
@Nullable
default String getRegionConcurrencyType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionconcurrencytype

getRegionOrder

@Stability(Stable)
@Nullable
default List<String> getRegionOrder()

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

RegionOrder isn't followed if AutoDeployment is enabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionorder

builder

@Stability(Stable)
static CfnStackSet.OperationPreferencesProperty.Builder builder()

Returns:

a CfnStackSet.OperationPreferencesProperty.Builder of CfnStackSet.OperationPreferencesProperty