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

Inherits:

Struct

• Object
• Struct
• Aws::EMR::Types::CloudWatchAlarmDefinition

Defined in:

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

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #comparison_operator ⇒ String

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

• #dimensions ⇒ Array<Types::MetricDimension>

  A CloudWatch metric dimension.

• #evaluation_periods ⇒ Integer

  The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity.

• #metric_name ⇒ String

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

• #namespace ⇒ String

  The namespace for the CloudWatch metric.

• #period ⇒ Integer

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

• #statistic ⇒ String

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

• #threshold ⇒ Float

  The value against which the specified statistic is compared.

• #unit ⇒ String

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

Instance Attribute Details

#comparison_operator ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 585

class CloudWatchAlarmDefinition < Struct.new(
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :namespace,
  :period,
  :statistic,
  :threshold,
  :unit,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#dimensions ⇒ Array<Types::MetricDimension>

A CloudWatch metric dimension.

Returns:

• (Array<Types::MetricDimension>)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 585

class CloudWatchAlarmDefinition < Struct.new(
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :namespace,
  :period,
  :statistic,
  :threshold,
  :unit,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_periods ⇒ Integer

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

Returns:

• (Integer)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 585

class CloudWatchAlarmDefinition < Struct.new(
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :namespace,
  :period,
  :statistic,
  :threshold,
  :unit,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 585

class CloudWatchAlarmDefinition < Struct.new(
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :namespace,
  :period,
  :statistic,
  :threshold,
  :unit,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 585

class CloudWatchAlarmDefinition < Struct.new(
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :namespace,
  :period,
  :statistic,
  :threshold,
  :unit,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 585

class CloudWatchAlarmDefinition < Struct.new(
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :namespace,
  :period,
  :statistic,
  :threshold,
  :unit,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#statistic ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 585

class CloudWatchAlarmDefinition < Struct.new(
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :namespace,
  :period,
  :statistic,
  :threshold,
  :unit,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#threshold ⇒ Float

The value against which the specified statistic is compared.

Returns:

• (Float)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 585

class CloudWatchAlarmDefinition < Struct.new(
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :namespace,
  :period,
  :statistic,
  :threshold,
  :unit,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 585

class CloudWatchAlarmDefinition < Struct.new(
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :namespace,
  :period,
  :statistic,
  :threshold,
  :unit,
  :dimensions)
  SENSITIVE = []
  include Aws::Structure
end