You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudFormation::Types::StackSetOperationPreferences

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass StackSetOperationPreferences data as a hash:

{
  region_order: ["Region"],
  failure_tolerance_count: 1,
  failure_tolerance_percentage: 1,
  max_concurrent_count: 1,
  max_concurrent_percentage: 1,
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#failure_tolerance_countInteger

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

Returns:

  • (Integer)


3752
3753
3754
3755
3756
3757
3758
3759
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3752

class StackSetOperationPreferences < Struct.new(
  :region_order,
  :failure_tolerance_count,
  :failure_tolerance_percentage,
  :max_concurrent_count,
  :max_concurrent_percentage)
  include Aws::Structure
end

#failure_tolerance_percentageInteger

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.

Returns:

  • (Integer)


3752
3753
3754
3755
3756
3757
3758
3759
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3752

class StackSetOperationPreferences < Struct.new(
  :region_order,
  :failure_tolerance_count,
  :failure_tolerance_percentage,
  :max_concurrent_count,
  :max_concurrent_percentage)
  include Aws::Structure
end

#max_concurrent_countInteger

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCountMaxConcurrentCount is at most one more than the FailureToleranceCount .

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

Returns:

  • (Integer)


3752
3753
3754
3755
3756
3757
3758
3759
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3752

class StackSetOperationPreferences < Struct.new(
  :region_order,
  :failure_tolerance_count,
  :failure_tolerance_percentage,
  :max_concurrent_count,
  :max_concurrent_percentage)
  include Aws::Structure
end

#max_concurrent_percentageInteger

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.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

Returns:

  • (Integer)


3752
3753
3754
3755
3756
3757
3758
3759
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3752

class StackSetOperationPreferences < Struct.new(
  :region_order,
  :failure_tolerance_count,
  :failure_tolerance_percentage,
  :max_concurrent_count,
  :max_concurrent_percentage)
  include Aws::Structure
end

#region_orderArray<String>

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

Returns:

  • (Array<String>)


3752
3753
3754
3755
3756
3757
3758
3759
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3752

class StackSetOperationPreferences < Struct.new(
  :region_order,
  :failure_tolerance_count,
  :failure_tolerance_percentage,
  :max_concurrent_count,
  :max_concurrent_percentage)
  include Aws::Structure
end