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

Class: Aws::AutoScaling::Waiters::GroupExists

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ GroupExists

Returns a new instance of GroupExists

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 10
  • :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
37
38
39
40
41
42
43
44
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/waiters.rb', line 21

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

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :auto_scaling_group_names (Array<String>)

    The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

    If you omit this parameter, all Auto Scaling groups are described.

  • :next_token (String)

    The token for the next set of items to return. (You received this token from a previous call.)

  • :max_records (Integer)

    The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Returns:



48
49
50
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/waiters.rb', line 48

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