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

Class: Aws::EMR::Types::CloudWatchAlarmDefinition

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CloudWatchAlarmDefinition as input to an Aws::Client method, you can use a vanilla Hash:

{
  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",
    },
  ],
}

The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_operatorString

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

Possible values:

  • GREATER_THAN_OR_EQUAL
  • GREATER_THAN
  • LESS_THAN
  • LESS_THAN_OR_EQUAL

Returns:

  • (String)

    Determines how the metric specified by MetricName is compared to the value specified by Threshold.

#dimensionsArray<Types::MetricDimension>

A CloudWatch metric dimension.

Returns:

#evaluation_periodsInteger

The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

Returns:

  • (Integer)

    The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity.

#metric_nameString

The name of the CloudWatch metric that is watched to determine an alarm condition.

Returns:

  • (String)

    The name of the CloudWatch metric that is watched to determine an alarm condition.

#namespaceString

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

Returns:

  • (String)

    The namespace for the CloudWatch metric.

#periodInteger

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

Returns:

  • (Integer)

    The period, in seconds, over which the statistic is applied.

#statisticString

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

Possible values:

  • SAMPLE_COUNT
  • AVERAGE
  • SUM
  • MINIMUM
  • MAXIMUM

Returns:

  • (String)

    The statistic to apply to the metric associated with the alarm.

#thresholdFloat

The value against which the specified statistic is compared.

Returns:

  • (Float)

    The value against which the specified statistic is compared.

#unitString

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

Possible values:

  • 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

Returns:

  • (String)

    The unit of measure associated with the CloudWatch metric being watched.