Interface CfnStackSet.IOperationPreferencesProperty

The user-specified preferences for how CloudFormation performs a StackSet operation.

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnStackSet.IOperationPreferencesProperty

Syntax (vb)

Public Interface CfnStackSet.IOperationPreferencesProperty

Remarks

For more information on maximum concurrent accounts and failure tolerance, see StackSet operation options in the AWS CloudFormation User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html

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 {
                 ConcurrencyMode = "concurrencyMode",
                 FailureToleranceCount = 123,
                 FailureTolerancePercentage = 123,
                 MaxConcurrentCount = 123,
                 MaxConcurrentPercentage = 123,
                 RegionConcurrencyType = "regionConcurrencyType",
                 RegionOrder = new [] { "regionOrder" }
             };

Synopsis

Properties

ConcurrencyMode	Specifies how the concurrency level behaves during the operation execution.
FailureToleranceCount	The number of accounts per Region this operation can fail in before CloudFormation stops the operation in that Region.
FailureTolerancePercentage	The percentage of accounts per Region this stack operation can fail in before 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

ConcurrencyMode

Specifies how the concurrency level behaves during the operation execution.

string? ConcurrencyMode { get; }

Property Value

string

Remarks

If failure tolerance or Maximum concurrent accounts are set to percentages, the behavior is similar.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-concurrencymode

FailureToleranceCount

The number of accounts per Region this operation can fail in before CloudFormation stops the operation in that Region.

double? FailureToleranceCount { get; }

Property Value

double?

Remarks

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

FailureTolerancePercentage

The percentage of accounts per Region this stack operation can fail in before CloudFormation stops the operation in that Region.

double? FailureTolerancePercentage { get; }

Property Value

double?

Remarks

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.

MaxConcurrentCount

The maximum number of accounts in which to perform this operation at one time.

double? MaxConcurrentCount { get; }

Property Value

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.

double? MaxConcurrentPercentage { get; }

Property Value

double?

Remarks

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.

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.

string? RegionConcurrencyType { get; }

Property Value

string

Remarks

RegionOrder

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

string[]? RegionOrder { get; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionorder