Class: Aws::Proton::Waiters::EnvironmentDeployed

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

Overview

Wait until an Environment is deployed. Use this after invoking CreateEnvironment or UpdateEnvironment

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ EnvironmentDeployed

Returns a new instance of EnvironmentDeployed.

Parameters:

  • options (Hash)

Options Hash (options):

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


183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/aws-sdk-proton/waiters.rb', line 183

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 999,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_environment,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "environment.deployment_status",
          "state" => "success",
          "expected" => "SUCCEEDED"
        },
        {
          "matcher" => "path",
          "argument" => "environment.deployment_status",
          "state" => "failure",
          "expected" => "FAILED"
        }
      ]
    )
  }.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. 



215
216
217
 
# File 'lib/aws-sdk-proton/waiters.rb', line 215

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :name (required, String) —

    The name of the environment that you want to get the detailed data for.

Returns:



210
211
212
 
# File 'lib/aws-sdk-proton/waiters.rb', line 210

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