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

Class: Aws::OpsWorks::Types::AutoScalingThresholds

Inherits:

Struct

• Object
• Struct
• Aws::OpsWorks::Types::AutoScalingThresholds

Defined in:

gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb

Overview

Note:

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

{
  instance_count: 1,
  thresholds_wait_time: 1,
  ignore_metrics_time: 1,
  cpu_threshold: 1.0,
  memory_threshold: 1.0,
  load_threshold: 1.0,
  alarms: ["String"],
}

Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks Stacks starts or stops load-based instances.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #alarms ⇒ Array<String>

  Custom Cloudwatch auto scaling alarms, to be used as thresholds.

• #cpu_threshold ⇒ Float

  The CPU utilization threshold, as a percent of the available CPU.

• #ignore_metrics_time ⇒ Integer

  The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events.

• #instance_count ⇒ Integer

  The number of instances to add or remove when the load exceeds a threshold.

• #load_threshold ⇒ Float

  The load threshold.

• #memory_threshold ⇒ Float

  The memory utilization threshold, as a percent of the available memory.

• #thresholds_wait_time ⇒ Integer

  The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

Instance Attribute Details

#alarms ⇒ Array<String>

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 301

class AutoScalingThresholds < Struct.new(
  :instance_count,
  :thresholds_wait_time,
  :ignore_metrics_time,
  :cpu_threshold,
  :memory_threshold,
  :load_threshold,
  :alarms)
  include Aws::Structure
end

#cpu_threshold ⇒ Float

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

Returns:

• (Float)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 301

class AutoScalingThresholds < Struct.new(
  :instance_count,
  :thresholds_wait_time,
  :ignore_metrics_time,
  :cpu_threshold,
  :memory_threshold,
  :load_threshold,
  :alarms)
  include Aws::Structure
end

#ignore_metrics_time ⇒ Integer

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

Returns:

• (Integer)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 301

class AutoScalingThresholds < Struct.new(
  :instance_count,
  :thresholds_wait_time,
  :ignore_metrics_time,
  :cpu_threshold,
  :memory_threshold,
  :load_threshold,
  :alarms)
  include Aws::Structure
end

#instance_count ⇒ Integer

The number of instances to add or remove when the load exceeds a threshold.

Returns:

• (Integer)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 301

class AutoScalingThresholds < Struct.new(
  :instance_count,
  :thresholds_wait_time,
  :ignore_metrics_time,
  :cpu_threshold,
  :memory_threshold,
  :load_threshold,
  :alarms)
  include Aws::Structure
end

#load_threshold ⇒ Float

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

Returns:

• (Float)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 301

class AutoScalingThresholds < Struct.new(
  :instance_count,
  :thresholds_wait_time,
  :ignore_metrics_time,
  :cpu_threshold,
  :memory_threshold,
  :load_threshold,
  :alarms)
  include Aws::Structure
end

#memory_threshold ⇒ Float

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

Returns:

• (Float)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 301

class AutoScalingThresholds < Struct.new(
  :instance_count,
  :thresholds_wait_time,
  :ignore_metrics_time,
  :cpu_threshold,
  :memory_threshold,
  :load_threshold,
  :alarms)
  include Aws::Structure
end

#thresholds_wait_time ⇒ Integer

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

Returns:

• (Integer)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 301

class AutoScalingThresholds < Struct.new(
  :instance_count,
  :thresholds_wait_time,
  :ignore_metrics_time,
  :cpu_threshold,
  :memory_threshold,
  :load_threshold,
  :alarms)
  include Aws::Structure
end