Interface CfnStackSet.IOperationPreferencesProperty

Namespace

Amazon.CDK

Assembly

Amazon.CDK.dll

The user-specified preferences for how AWS CloudFormation performs a stack set operation.

public interface CfnStackSet.IOperationPreferencesProperty

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" }
             };

Remarks

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options .

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

ExampleMetadata: fixture=_generated

Properties

FailureToleranceCount

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

double? FailureToleranceCount { get; }

Property Value

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

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

FailureTolerancePercentage

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

double? FailureTolerancePercentage { get; }

Property Value

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.

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

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.

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

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

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

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

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

RegionOrder

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

string[]? RegionOrder { get; }

Property Value

string[]

Remarks

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