1.204.0

interface OperationPreferencesProperty

LanguageType name
.NETAmazon.CDK.CfnStackSet.OperationPreferencesProperty
Javasoftware.amazon.awscdk.core.CfnStackSet.OperationPreferencesProperty
Pythonaws_cdk.core.CfnStackSet.OperationPreferencesProperty
TypeScript @aws-cdk/core » CfnStackSet » OperationPreferencesProperty

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 * as cdk from '@aws-cdk/core';
const operationPreferencesProperty: cdk.CfnStackSet.OperationPreferencesProperty = {
  failureToleranceCount: 123,
  failureTolerancePercentage: 123,
  maxConcurrentCount: 123,
  maxConcurrentPercentage: 123,
  regionConcurrencyType: 'regionConcurrencyType',
  regionOrder: ['regionOrder'],
};

Properties

NameTypeDescription
failureToleranceCount?numberThe number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region.
failureTolerancePercentage?numberThe percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.
maxConcurrentCount?numberThe maximum number of accounts in which to perform this operation at one time.
maxConcurrentPercentage?numberThe maximum percentage of accounts in which to perform this operation at one time.
regionConcurrencyType?stringThe concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
regionOrder?string[]The order of the Regions where you want to perform the stack operation.

failureToleranceCount?

Type: number (optional)

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

failureTolerancePercentage?

Type: number (optional)

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.

maxConcurrentCount?

Type: number (optional)

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.

maxConcurrentPercentage?

Type: number (optional)

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.

regionConcurrencyType?

Type: string (optional)

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

regionOrder?

Type: string[] (optional)

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

← PreviousNext →