Interface CfnStackSet.IOperationPreferencesProperty
The user-specified preferences for how AWS CloudFormation performs a stack set operation.
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public interface IOperationPreferencesProperty
Syntax (vb)
Public Interface IOperationPreferencesProperty
Remarks
For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options .
ExampleMetadata: fixture=_generated
Examples
// 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 {
FailureToleranceCount = 123,
FailureTolerancePercentage = 123,
MaxConcurrentCount = 123,
MaxConcurrentPercentage = 123,
RegionConcurrencyType = "regionConcurrencyType",
RegionOrder = new [] { "regionOrder" }
};
Synopsis
Properties
FailureToleranceCount | The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region. |
FailureTolerancePercentage | The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. |
MaxConcurrentCount | The maximum number of accounts in which to perform this operation at one time. |
MaxConcurrentPercentage | The maximum percentage of accounts in which to perform this operation at one time. |
RegionConcurrencyType | The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time. |
RegionOrder | The order of the Regions where you want to perform the stack operation. |
Properties
FailureToleranceCount
The number of accounts, per Region, for which this operation can fail before AWS CloudFormation stops the operation in that Region.
virtual Nullable<double> FailureToleranceCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
The percentage of accounts, per Region, for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.
virtual Nullable<double> FailureTolerancePercentage { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
The maximum number of accounts in which to perform this operation at one time.
virtual Nullable<double> MaxConcurrentCount { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
The maximum percentage of accounts in which to perform this operation at one time.
virtual Nullable<double> MaxConcurrentPercentage { get; }
Property Value
System.Nullable<System.Double>
Remarks
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
The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
virtual string RegionConcurrencyType { get; }
Property Value
System.String
Remarks
RegionOrder
The order of the Regions where you want to perform the stack operation.
virtual string[] RegionOrder { get; }
Property Value
System.String[]