Class AWS::CloudWatch::Alarm
In: lib/aws/cloud_watch/alarm.rb
Parent: Core::Resource

@attr_reader [String] metric_name

@attr_reader [String] namespace

@attr_reader [Array<Hash>] dimensions

@attr_reader [Boolean] enabled Indicates whether actions

  should be executed during any changes to the alarm's state.

@attr_reader [Array<String>] alarm_actions The list of actions to execute

  when this alarm transitions into an ALARM state from any other
  state.

@attr_reader [String] arn The Amazon Resource Name (ARN) of the alarm.

@attr_reader [Time] configuration_updated_timestamp

  The time stamp of the last update to the alarm configuration.

@attr_reader [String] description The description for the alarm.

@attr_reader [String] comparison_operator The arithmetic operation to

  use when comparing the specified Statistic and Threshold. The
  specified Statistic value is used as the first operand.

@attr_reader [Integer] evaluation_periods The number of periods over

  which data is compared to the specified threshold.

@attr_reader [Array<Hash>] insufficient_data_actions The list of

  actions to execute when this alarm transitions into an
  INSUFFICIENT_DATA state

@attr_reader [Array<Hash>] ok_actions The list of actions to execute

  when this alarm transitions into an OK state.

@attr_reader [Integer] period The period in seconds over which the

  statistic is applied.

@attr_reader [String] state_reason A human-readable explanation for

  the alarm's state.

@attr_reader [String] state_reason_data An explanation for the alarm‘s

  state in machine-readable JSON format.

@attr_reader [Time] state_updated_timestamp When the alarm‘s state

  last updated.

@attr_reader [String] state_value The state value for the alarm.

@attr_reader [Float] threshold The value against which the specified

  statistic is compared.

@attr_reader [String] unit The unit of the alarm‘s associated metric.

Methods

External Aliases

alarm_name -> name
actions_enabled -> enabled
enabled -> enabled?
alarm_actions -> actions
alarm_arn -> arn
alarm_configuration_updated_timestamp -> configuration_updated_timestamp
alarm_description -> description

Attributes

alarm_name  [R]  @return [String]

Public Class methods

Public Instance methods

Deletes the current alarm. @return [nil]

Disable the current alarm actions. @return [nil]

Enable the current alarm actions. @return [nil]

@return [Boolean] Returns true if this alarm exists.

histories(options = {})

Alias for history_items

history(options = {})

Alias for history_items

Returns a collection of the history items for current alarm. @return [AlarmHistoryItemCollection]

@return [Metric]

Temporarily sets the state of current alarm. @param [String] reason The reason that this alarm is set to this

  specific state (in human-readable text format).

@param [String] value Valid values include:

  * 'OK'
  * 'ALARM'
  * 'INSUFFICIENT_DATA'

@param [Hash] options @option options [String] :state_reason_data The reason that this

  alarm is set to this specific state (in machine-readable JSON
  format)

@return [nil]

Updates the metric alarm.

@option options [String,required] :comparison_operator The arithmetic

  operation to use when comparing the specified Statistic and
  Threshold. The specified Statistic value is used as the first
  operand.  Valid values include:

    * 'GreaterThanOrEqualToThreshold'
    * 'GreaterThanThreshold'
    * 'LessThanThreshold'
    * 'LessThanOrEqualToThreshold'

@option options [String,required] :namespace The namespace for the

  alarm's associated metric.

@option options [Integer,required] :evaluation_periods The number

  of periods over which data is compared to the specified threshold.

@option options [Integer,required] :period The period in seconds

  over which the specified statistic is applied.

@option options [String,required] :statistic The statistic to apply

  to the alarm's associated metric. Valid values include:

    * 'SampleCount'
    * 'Average'
    * 'Sum'
    * 'Minimum'
    * 'Maximum'

@option options [Number,required] :threshold The value against which

  the specified statistic is compared.

@option options [Array<String>] :insufficient_data_actions

  The list of actions to execute when this alarm transitions into an
  INSUFFICIENT_DATA state from any other state. Each action is
  specified as an Amazon Resource Number (ARN). Currently the only
  action supported is publishing to an Amazon SNS topic or an
  Amazon Auto Scaling policy.

@option options [Array<String>] :ok_actions The list of actions to

  execute when this alarm transitions into an OK state from any
  other state. Each action is specified as an Amazon Resource
  Number (ARN). Currently the only action supported is publishing to
  an Amazon SNS topic or an Amazon Auto Scaling policy.

@option options [Boolean] :actions_enabled Indicates whether or not

  actions should be executed during any changes to the alarm's
  state.

@option options [Array<String>] :alarm_actions The list of actions

  to execute when this alarm transitions into an ALARM state from
  any other state. Each action is specified as an Amazon Resource
  Number (ARN). Currently the only action supported is publishing
  to an Amazon SNS topic or an Amazon Auto Scaling policy.
  Maximum of 5 alarm actions.

@option options [String] :alarm_description The description for

  the alarm.

@option options [String] :unit The unit for the alarm‘s associated

  metric.

@return [nil]

Protected Instance methods

[Validate]