StackSetOperationPreferences - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

StackSetOperationPreferences

The user-specified preferences for how Amazon CloudFormation performs a stack set operation.

For more information about maximum concurrent accounts and failure tolerance, see Stack set operation options.

Contents

FailureToleranceCount

The number of accounts, per Region, for which this operation can fail before Amazon CloudFormation stops the operation in that Region. If the operation is stopped in a Region, Amazon 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.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

FailureTolerancePercentage

The percentage of accounts, per Region, for which this stack operation can fail before Amazon CloudFormation stops the operation in that Region. If the operation is stopped in a Region, Amazon CloudFormation doesn't attempt the operation in any subsequent Regions.

When calculating the number of accounts based on the specified percentage, Amazon CloudFormation rounds down to the next whole number.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

By default, 0 is specified.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

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, Amazon 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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

RegionConcurrencyType

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

Type: String

Valid Values: SEQUENTIAL | PARALLEL

Required: No

RegionOrder.member.N

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

Type: Array of strings

Pattern: ^[a-zA-Z0-9-]{1,128}$

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: