Class: Aws::Proton::Waiters::ComponentDeployed

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

Overview

Wait until a Component is deployed. Use this after invoking CreateComponent or UpdateComponent

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ComponentDeployed

Returns a new instance of ComponentDeployed.

Parameters:

  • options (Hash)

Options Hash (options):

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


138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/aws-sdk-proton/waiters.rb', line 138

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_component,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "component.deployment_status",
          "state" => "success",
          "expected" => "SUCCEEDED"
        },
        {
          "matcher" => "path",
          "argument" => "component.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. 



170
171
172
 
# File 'lib/aws-sdk-proton/waiters.rb', line 170

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :name (required, String) —

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

Returns:



165
166
167
 
# File 'lib/aws-sdk-proton/waiters.rb', line 165

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