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

Class: Aws::EMR::Types::ScalingRule

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

Overview

Note:

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

{
  name: "String", # required
  description: "String",
  action: { # required
    market: "ON_DEMAND", # accepts ON_DEMAND, SPOT
    simple_scaling_policy_configuration: { # required
      adjustment_type: "CHANGE_IN_CAPACITY", # accepts CHANGE_IN_CAPACITY, PERCENT_CHANGE_IN_CAPACITY, EXACT_CAPACITY
      scaling_adjustment: 1, # required
      cool_down: 1,
    },
  },
  trigger: { # required
    cloud_watch_alarm_definition: { # required
      comparison_operator: "GREATER_THAN_OR_EQUAL", # required, accepts GREATER_THAN_OR_EQUAL, GREATER_THAN, LESS_THAN, LESS_THAN_OR_EQUAL
      evaluation_periods: 1,
      metric_name: "String", # required
      namespace: "String",
      period: 1, # required
      statistic: "SAMPLE_COUNT", # accepts SAMPLE_COUNT, AVERAGE, SUM, MINIMUM, MAXIMUM
      threshold: 1.0, # required
      unit: "NONE", # accepts NONE, SECONDS, MICRO_SECONDS, MILLI_SECONDS, BYTES, KILO_BYTES, MEGA_BYTES, GIGA_BYTES, TERA_BYTES, BITS, KILO_BITS, MEGA_BITS, GIGA_BITS, TERA_BITS, PERCENT, COUNT, BYTES_PER_SECOND, KILO_BYTES_PER_SECOND, MEGA_BYTES_PER_SECOND, GIGA_BYTES_PER_SECOND, TERA_BYTES_PER_SECOND, BITS_PER_SECOND, KILO_BITS_PER_SECOND, MEGA_BITS_PER_SECOND, GIGA_BITS_PER_SECOND, TERA_BITS_PER_SECOND, COUNT_PER_SECOND
      dimensions: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  },
}

A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ Types::ScalingAction

The conditions that trigger an automatic scaling activity.

Returns:



4694
4695
4696
4697
4698
4699
4700
 
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4694

class ScalingRule < Struct.new(
  :name,
  :description,
  :action,
  :trigger)
  include Aws::Structure
end

#description ⇒ String

A friendly, more verbose description of the automatic scaling rule.

Returns:

  • (String) 


4694
4695
4696
4697
4698
4699
4700
 
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4694

class ScalingRule < Struct.new(
  :name,
  :description,
  :action,
  :trigger)
  include Aws::Structure
end

#name ⇒ String

The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.

Returns:

  • (String) 


4694
4695
4696
4697
4698
4699
4700
 
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4694

class ScalingRule < Struct.new(
  :name,
  :description,
  :action,
  :trigger)
  include Aws::Structure
end

#trigger ⇒ Types::ScalingTrigger

The CloudWatch alarm definition that determines when automatic scaling activity is triggered.

Returns:



4694
4695
4696
4697
4698
4699
4700
 
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 4694

class ScalingRule < Struct.new(
  :name,
  :description,
  :action,
  :trigger)
  include Aws::Structure
end