Class: Aws::Proton::Waiters::EnvironmentTemplateVersionRegistered

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

Overview

Wait until an EnvironmentTemplateVersion is registered. Use this after invoking CreateEnvironmentTemplateVersion

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ EnvironmentTemplateVersionRegistered

Returns a new instance of EnvironmentTemplateVersionRegistered.

Parameters:

  • options (Hash)

Options Hash (options):

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


228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/aws-sdk-proton/waiters.rb', line 228

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 150,
    delay: 2,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_environment_template_version,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "environment_template_version.status",
          "state" => "success",
          "expected" => "DRAFT"
        },
        {
          "matcher" => "path",
          "argument" => "environment_template_version.status",
          "state" => "success",
          "expected" => "PUBLISHED"
        },
        {
          "matcher" => "path",
          "argument" => "environment_template_version.status",
          "state" => "failure",
          "expected" => "REGISTRATION_FAILED"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiterObject (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.



266
267
268
# File 'lib/aws-sdk-proton/waiters.rb', line 266

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :major_version (required, String)

    To get environment template major version detail data, include ‘major Version`.

  • :minor_version (required, String)

    To get environment template minor version detail data, include ‘minorVersion`.

  • :template_name (required, String)

    The name of the environment template a version of which you want to get detailed data for.

Returns:



261
262
263
# File 'lib/aws-sdk-proton/waiters.rb', line 261

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