Class: Aws::Lambda::Waiters::FunctionActiveV2

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

Overview

Waits for the function’s State to be Active. This waiter uses GetFunction API. This should be used after new function creation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ FunctionActiveV2

Returns a new instance of FunctionActiveV2.

Parameters:

  • options (Hash)

Options Hash (options):

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


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
 
# File 'lib/aws-sdk-lambda/waiters.rb', line 141

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 300,
    delay: 1,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_function,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "configuration.state",
          "expected" => "Active"
        },
        {
          "state" => "failure",
          "matcher" => "path",
          "argument" => "configuration.state",
          "expected" => "Failed"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "configuration.state",
          "expected" => "Pending"
        }
      ]
    )
  }.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. 



179
180
181
 
# File 'lib/aws-sdk-lambda/waiters.rb', line 179

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :function_name (required, String) —

    The name or ARN of the Lambda function, version, or alias.

    **Name formats**

    • **Function name** – ‘my-function` (name-only), `my-function:v1` (with alias).

    • **Function ARN** – ‘arn:aws:lambda:us-west-2:123456789012:function:my-function`.

    • **Partial ARN** – ‘123456789012:function:my-function`.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :qualifier (String) —

    Specify a version or alias to get details about a published version of the function.

Returns:



174
175
176
 
# File 'lib/aws-sdk-lambda/waiters.rb', line 174

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