OperationPreferencesProperty Struct
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 CloudFormation User Guide .
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-lib';
const operationPreferencesProperty: cdk.CfnStackSet.OperationPreferencesProperty = {
concurrencyMode: 'concurrencyMode',
failureToleranceCount: 123,
failureTolerancePercentage: 123,
maxConcurrentCount: 123,
maxConcurrentPercentage: 123,
regionConcurrencyType: 'regionConcurrencyType',
regionOrder: ['regionOrder'],
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
operation_preferences_property = cdk.CfnStackSet.OperationPreferencesProperty(
concurrency_mode="concurrencyMode",
failure_tolerance_count=123,
failure_tolerance_percentage=123,
max_concurrent_count=123,
max_concurrent_percentage=123,
region_concurrency_type="regionConcurrencyType",
region_order=["regionOrder"]
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
OperationPreferencesProperty operationPreferencesProperty = OperationPreferencesProperty.builder()
.concurrencyMode("concurrencyMode")
.failureToleranceCount(123)
.failureTolerancePercentage(123)
.maxConcurrentCount(123)
.maxConcurrentPercentage(123)
.regionConcurrencyType("regionConcurrencyType")
.regionOrder(List.of("regionOrder"))
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
var operationPreferencesProperty = new OperationPreferencesProperty {
ConcurrencyMode = "concurrencyMode",
FailureToleranceCount = 123,
FailureTolerancePercentage = 123,
MaxConcurrentCount = 123,
MaxConcurrentPercentage = 123,
RegionConcurrencyType = "regionConcurrencyType",
RegionOrder = new [] { "regionOrder" }
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
operationPreferencesProperty := &OperationPreferencesProperty{
ConcurrencyMode: jsii.String("concurrencyMode"),
FailureToleranceCount: jsii.Number(123),
FailureTolerancePercentage: jsii.Number(123),
MaxConcurrentCount: jsii.Number(123),
MaxConcurrentPercentage: jsii.Number(123),
RegionConcurrencyType: jsii.String("regionConcurrencyType"),
RegionOrder: []*string{
jsii.String("regionOrder"),
},
}
Properties
concurrencyModeoptionalstringconcurrency_modeoptionalstrconcurrencyModeoptionalStringConcurrencyModeoptionalstringConcurrencyModeoptional*string#notes
STRICT_FAILURE_TOLERANCE: This option dynamically lowers the concurrency level to ensure the number of failed accounts never exceeds the value ofFailureToleranceCount+1. The initial actual concurrency is set to the lower of either the value of theMaxConcurrentCount, or the value ofFailureToleranceCount+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 decouplesFailureToleranceCountfrom the actual concurrency. This allows StackSet operations to run at the concurrency level set by theMaxConcurrentCountvalue, orMaxConcurrentPercentage, regardless of the number of failures.
failureToleranceCountoptionalnumberfailure_tolerance_countoptionalint | floatfailureToleranceCountoptionalNumberFailureToleranceCountoptionaldoubleFailureToleranceCountoptional*float64#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).
failureTolerancePercentageoptionalnumberfailure_tolerance_percentageoptionalint | floatfailureTolerancePercentageoptionalNumberFailureTolerancePercentageoptionaldoubleFailureTolerancePercentageoptional*float64#notes
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.
maxConcurrentCountoptionalnumbermax_concurrent_countoptionalint | floatmaxConcurrentCountoptionalNumberMaxConcurrentCountoptionaldoubleMaxConcurrentCountoptional*float64#notes
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.
maxConcurrentPercentageoptionalnumbermax_concurrent_percentageoptionalint | floatmaxConcurrentPercentageoptionalNumberMaxConcurrentPercentageoptionaldoubleMaxConcurrentPercentageoptional*float64#notes
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.
regionConcurrencyTypeoptionalstringregion_concurrency_typeoptionalstrregionConcurrencyTypeoptionalStringRegionConcurrencyTypeoptionalstringRegionConcurrencyTypeoptional*string#regionOrderoptionalstring[]region_orderoptionaltyping.List[str]regionOrderoptionalList<String>RegionOrderoptionalstring[]RegionOrderoptional*[]*string#