Class: Aws::OpsWorks::Waiters::InstanceOnline

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

Overview

Wait until OpsWorks instance is online.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ InstanceOnline

Returns a new instance of InstanceOnline.

Parameters:

  • options (Hash)

Options Hash (options):

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


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/aws-sdk-opsworks/waiters.rb', line 109

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 15,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_instances,
      acceptors: [
        {
          "expected" => "online",
          "matcher" => "pathAll",
          "state" => "success",
          "argument" => "instances[].status"
        },
        {
          "expected" => "setup_failed",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "shutting_down",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "start_failed",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "stopped",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "stopping",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "terminating",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "terminated",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        },
        {
          "expected" => "stop_failed",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "instances[].status"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (readonly)

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. 



183
184
185
 
# File 'lib/aws-sdk-opsworks/waiters.rb', line 183

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :stack_id (String) —

    A stack ID. If you use this parameter, ‘DescribeInstances` returns descriptions of the instances associated with the specified stack.

  • :layer_id (String) —

    A layer ID. If you use this parameter, ‘DescribeInstances` returns descriptions of the instances associated with the specified layer.

  • :instance_ids (Array<String>) —

    An array of instance IDs to be described. If you use this parameter, ‘DescribeInstances` returns a description of the specified instances. Otherwise, it returns a description of every instance.

Returns:



178
179
180
 
# File 'lib/aws-sdk-opsworks/waiters.rb', line 178

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