Class: Aws::EventBridgeV2::Waiters::EventBusActive

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

Overview

Waits until the event bus reports ACTIVE. Use after CreateEventBus (bus starts in CREATING) or UpdateEventBus (bus moves to UPDATING) before invoking operations that require an ACTIVE bus. Fails fast on the terminal failure states CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED, surfacing StateReason. CREATING, UPDATING, and DELETING are intentionally unmodeled intermediate states that fall through to the implicit retry.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ EventBusActive

Returns a new instance of EventBusActive.

Parameters:

  • options (Hash)

Options Hash (options):

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


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/waiters.rb', line 86

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 2,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_event_bus,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "state",
          "state" => "failure",
          "expected" => "CREATE_FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "state",
          "state" => "failure",
          "expected" => "UPDATE_FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "state",
          "state" => "failure",
          "expected" => "DELETE_FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "state",
          "state" => "success",
          "expected" => "ACTIVE"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (params):

  • :event_bus_arn (required, String) —

    The Amazon Resource Name (ARN) that uniquely identifies an event bus.

Returns:



125
126
127
 
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/waiters.rb', line 125

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