Class: Aws::CloudFormation::Waiters::TypeRegistrationComplete

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

Overview

Wait until type registration is COMPLETE.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ TypeRegistrationComplete

Returns a new instance of TypeRegistrationComplete.

Parameters:

  • options (Hash)

Options Hash (options):

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


590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
# File 'lib/aws-sdk-cloudformation/waiters.rb', line 590

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



622
623
624
# File 'lib/aws-sdk-cloudformation/waiters.rb', line 622

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :registration_token (required, String)

    The identifier for this registration request.

    This registration token is generated by CloudFormation when you initiate a registration request using RegisterType.

Returns:



617
618
619
# File 'lib/aws-sdk-cloudformation/waiters.rb', line 617

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