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

Class: Aws::CloudWatch::Waiters::AlarmExists

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/waiters.rb

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ AlarmExists

Returns a new instance of AlarmExists

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 40
  • :delay (Integer) — default: 5
  • :before_attempt (Proc)
  • :before_wait (Proc)


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/waiters.rb', line 21

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_alarms,
      acceptors: [{
        "matcher" => "path",
        "expected" => true,
        "argument" => "length(metric_alarms[]) > `0`",
        "state" => "success"
      }]
    )
  }.merge(options))
end

Instance Method Details

#wait(params = {}) ⇒ Types::DescribeAlarmsOutput

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {})

    a customizable set of options

Options Hash (params):

  • :alarm_names (Array<String>)

    The names of the alarms.

  • :alarm_name_prefix (String)

    The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.

  • :state_value (String)

    The state value to be used in matching alarms.

  • :action_prefix (String)

    The action name prefix.

  • :max_records (Integer)

    The maximum number of alarm descriptions to retrieve.

  • :next_token (String)

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

Returns:



40
41
42
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/waiters.rb', line 40

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end