AWS::CloudFormation::StackSet OperationPreferences - Amazon CloudFormation
SyntaxProperties
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 (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::CloudFormation::StackSet OperationPreferences

The user-specified preferences for how CloudFormation performs a StackSet operation. For more information on maximum concurrent accounts and failure tolerance, see StackSet operation options in the Amazon CloudFormation User Guide.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "ConcurrencyMode" : String,
  "FailureToleranceCount" : Integer,
  "FailureTolerancePercentage" : Integer,
  "MaxConcurrentCount" : Integer,
  "MaxConcurrentPercentage" : Integer,
  "RegionConcurrencyType" : String,
  "RegionOrder" : [ String, ... ]
}

Properties

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.

Required: No

Type: String

Allowed values: STRICT_FAILURE_TOLERANCE | SOFT_FAILURE_TOLERANCE

Update requires: No interruption

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).

Required: Conditional

Type: Integer

Minimum: 0

Update requires: No interruption

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.

Required: Conditional

Type: Integer

Minimum: 0

Maximum: 100

Update requires: No interruption

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.

Required: Conditional

Type: Integer

Minimum: 1

Update requires: No interruption

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.

Required: Conditional

Type: Integer

Minimum: 0

Maximum: 100

Update requires: No interruption

RegionConcurrencyType

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

Required: No

Type: String

Allowed values: SEQUENTIAL | PARALLEL

Update requires: No interruption

RegionOrder

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

Required: No

Type: Array of String

Update requires: No interruption