Class: Aws::CloudWatch::CompositeAlarm

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-cloudwatch/composite_alarm.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ CompositeAlarm #initialize(options = {}) ⇒ CompositeAlarm

Returns a new instance of CompositeAlarm.

Overloads:

  • #initialize(name, options = {}) ⇒ CompositeAlarm

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ CompositeAlarm

    Options Hash (options):

    • :name (required, String)
    • :client (Client) 


22
23
24
25
26
27
28
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#actions_enabled ⇒ Boolean

Indicates whether actions should be executed during any changes to the alarm state.

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 41

def actions_enabled
  data[:actions_enabled]
end

#actions_suppressed_by ⇒ String

When the value is ‘ALARM`, it means that the actions are suppressed because the suppressor alarm is in `ALARM` When the value is `WaitPeriod`, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the `ALARM` state. The maximum waiting time is as specified in `ActionsSuppressorWaitPeriod`. After this time, the composite alarm performs its actions. When the value is `ExtensionPeriod`, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of the `ALARM` state. The maximum waiting time is as specified in `ActionsSuppressorExtensionPeriod`. After this time, the composite alarm performs its actions.

Returns:

  • (String) 


136
137
138
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 136

def actions_suppressed_by
  data[:actions_suppressed_by]
end

#actions_suppressed_reason ⇒ String

Captures the reason for action suppression.

Returns:

  • (String) 


142
143
144
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 142

def actions_suppressed_reason
  data[:actions_suppressed_reason]
end

#actions_suppressor ⇒ String

Actions will be suppressed if the suppressor alarm is in the ‘ALARM` state. `ActionsSuppressor` can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

Returns:

  • (String) 


150
151
152
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 150

def actions_suppressor
  data[:actions_suppressor]
end

#actions_suppressor_extension_period ⇒ Integer

The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ‘ALARM` state. After this time, the composite alarm performs its actions.

‘ExtensionPeriod` is required only when `ActionsSuppressor` is specified.

Returns:

  • (Integer) 


171
172
173
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 171

def actions_suppressor_extension_period
  data[:actions_suppressor_extension_period]
end

#actions_suppressor_wait_period ⇒ Integer

The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ‘ALARM` state. After this time, the composite alarm performs its actions.

‘WaitPeriod` is required only when `ActionsSuppressor` is specified.

Returns:

  • (Integer) 


160
161
162
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 160

def actions_suppressor_wait_period
  data[:actions_suppressor_wait_period]
end

#alarm_actions ⇒ Array<String>

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

  • (Array<String>) 


49
50
51
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 49

def alarm_actions
  data[:alarm_actions]
end

#alarm_arn ⇒ String

The Amazon Resource Name (ARN) of the alarm.

Returns:

  • (String) 


55
56
57
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 55

def alarm_arn
  data[:alarm_arn]
end

#alarm_configuration_updated_timestamp ⇒ Time

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

Returns:

  • (Time) 


61
62
63
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 61

def alarm_configuration_updated_timestamp
  data[:alarm_configuration_updated_timestamp]
end

#alarm_description ⇒ String

The description of the alarm.

Returns:

  • (String) 


67
68
69
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 67

def alarm_description
  data[:alarm_description]
end

#alarm_rule ⇒ String

The rule that this alarm uses to evaluate its alarm state.

Returns:

  • (String) 


73
74
75
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 73

def alarm_rule
  data[:alarm_rule]
end

#client ⇒ Client

Returns:



178
179
180
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 178

def client
  @client
end

#data ⇒ Types::CompositeAlarm

Returns the data for this Aws::CloudWatch::CompositeAlarm. Calls Aws::CloudWatch::Client#describe_alarms if #data_loaded? is ‘false`.

Returns:



200
201
202
203
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 200

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns ‘true` if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



208
209
210
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 208

def data_loaded?
  !!@data
end

#delete(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


composite_alarm.delete()

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:

  • (EmptyStructure) 


351
352
353
354
355
356
357
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 351

def delete(options = {})
  options = Aws::Util.deep_merge(options, alarm_names: [@name])
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_alarms(options)
  end
  resp.data
end

#describe_history(options = {}) ⇒ Types::DescribeAlarmHistoryOutput

Examples:

Request syntax with placeholder values


composite_alarm.describe_history({
  alarm_types: ["CompositeAlarm"], # accepts CompositeAlarm, MetricAlarm
  history_item_type: "ConfigurationUpdate", # accepts ConfigurationUpdate, StateUpdate, Action
  start_date: Time.now,
  end_date: Time.now,
  max_records: 1,
  next_token: "NextToken",
  scan_by: "TimestampDescending", # accepts TimestampDescending, TimestampAscending
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :alarm_types (Array<String>) —

    Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.

  • :history_item_type (String) —

    The type of alarm histories to retrieve.

  • :start_date (Time, DateTime, Date, Integer, String) —

    The starting date to retrieve alarm history.

  • :end_date (Time, DateTime, Date, Integer, String) —

    The ending date to retrieve alarm history.

  • :max_records (Integer) —

    The maximum number of alarm history records to retrieve.

  • :next_token (String) —

    The token returned by a previous call to indicate that there is more data available.

  • :scan_by (String) —

    Specified whether to return the newest or oldest alarm history first. Specify ‘TimestampDescending` to have the newest event history returned first, and specify `TimestampAscending` to have the oldest history returned first.

Returns:



392
393
394
395
396
397
398
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 392

def describe_history(options = {})
  options = options.merge(alarm_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.describe_alarm_history(options)
  end
  resp.data
end

#disable_actions(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


composite_alarm.disable_actions()

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:

  • (EmptyStructure) 


405
406
407
408
409
410
411
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 405

def disable_actions(options = {})
  options = Aws::Util.deep_merge(options, alarm_names: [@name])
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.disable_alarm_actions(options)
  end
  resp.data
end

#enable_actions(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


composite_alarm.enable_actions()

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:

  • (EmptyStructure) 


418
419
420
421
422
423
424
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 418

def enable_actions(options = {})
  options = Aws::Util.deep_merge(options, alarm_names: [@name])
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.enable_alarm_actions(options)
  end
  resp.data
end

#exists?(options = {}) ⇒ Boolean

Returns ‘true` if the CompositeAlarm exists.

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Boolean) —

    Returns ‘true` if the CompositeAlarm exists.



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 215

def exists?(options = {})
  begin
    wait_until_exists(options.merge(max_attempts: 1))
    true
  rescue Aws::Waiters::Errors::UnexpectedError => e
    raise e.error
  rescue Aws::Waiters::Errors::WaiterFailed
    false
  end
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


458
459
460
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 458

def identifiers
  { name: @name }
end

#insufficient_data_actions ⇒ Array<String>

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

  • (Array<String>) 


81
82
83
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 81

def insufficient_data_actions
  data[:insufficient_data_actions]
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::CloudWatch::CompositeAlarm. Returns ‘self` making it possible to chain methods.

composite_alarm.reload.data

Returns:

  • (self) 


188
189
190
191
192
193
194
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 188

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.describe_alarms(alarm_names: [@name])
  end
  @data = resp.composite_alarms[0]
  self
end

#name ⇒ String Also known as: alarm_name

Returns:

  • (String) 


33
34
35
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 33

def name
  @name
end

#ok_actions ⇒ Array<String>

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

  • (Array<String>) 


89
90
91
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 89

def ok_actions
  data[:ok_actions]
end

#set_state(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


composite_alarm.set_state({
  state_value: "OK", # required, accepts OK, ALARM, INSUFFICIENT_DATA
  state_reason: "StateReason", # required
  state_reason_data: "StateReasonData",
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :state_value (required, String) —

    The value of the state.

  • :state_reason (required, String) —

    The reason that this alarm is set to this specific state, in text format.

  • :state_reason_data (String) —

    The reason that this alarm is set to this specific state, in JSON format.

    For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.

Returns:

  • (EmptyStructure) 


448
449
450
451
452
453
454
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 448

def set_state(options = {})
  options = options.merge(alarm_name: @name)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.set_alarm_state(options)
  end
  resp.data
end

#state_reason ⇒ String

An explanation for the alarm state, in text format.

Returns:

  • (String) 


95
96
97
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 95

def state_reason
  data[:state_reason]
end

#state_reason_data ⇒ String

An explanation for the alarm state, in JSON format.

Returns:

  • (String) 


101
102
103
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 101

def state_reason_data
  data[:state_reason_data]
end

#state_transitioned_timestamp ⇒ Time

The timestamp of the last change to the alarm’s ‘StateValue`.

Returns:

  • (Time) 


120
121
122
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 120

def state_transitioned_timestamp
  data[:state_transitioned_timestamp]
end

#state_updated_timestamp ⇒ Time

Tracks the timestamp of any state update, even if ‘StateValue` doesn’t change.

Returns:

  • (Time) 


108
109
110
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 108

def state_updated_timestamp
  data[:state_updated_timestamp]
end

#state_value ⇒ String

The state value for the alarm.

Returns:

  • (String) 


114
115
116
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 114

def state_value
  data[:state_value]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::CloudWatch::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

## Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

## Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

## Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 325

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end

#wait_until_exists(options = {}, &block) ⇒ CompositeAlarm

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer) — default: 40
  • :delay (Float) — default: 5
  • :before_attempt (Proc)
  • :before_wait (Proc)

Returns:



232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/aws-sdk-cloudwatch/composite_alarm.rb', line 232

def wait_until_exists(options = {}, &block)
  options, params = separate_params_and_options(options)
  waiter = Waiters::CompositeAlarmExists.new(options)
  yield_waiter_and_warn(waiter, &block) if block_given?
  Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    waiter.wait(params.merge(alarm_names: [@name]))
  end
  CompositeAlarm.new({
    name: @name,
    client: @client
  })
end