You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::RDS::Event

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(source_id, date, options = {}) ⇒ Event #initialize(options = {}) ⇒ Event

Returns a new instance of Event

Overloads:

  • #initialize(source_id, date, options = {}) ⇒ Event

    Parameters:

    • source_id (String)
    • date (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Event

    Options Hash (options):

    • :source_id (required, String)
    • :date (required, String)
    • :client (Client)


21
22
23
24
25
26
27
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 21

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @source_id = extract_source_id(args, options)
  @date = extract_date(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#clientClient

Returns:



69
70
71
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 69

def client
  @client
end

#dataTypes::Event

Returns the data for this Aws::RDS::Event.

Returns:

Raises:



84
85
86
87
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 84

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



92
93
94
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 92

def data_loaded?
  !!@data
end

#dateString

Returns:

  • (String)


38
39
40
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 38

def date
  @date
end

#event_categoriesArray<String>

Specifies the category for the event.

Returns:

  • (Array<String>)


56
57
58
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 56

def event_categories
  data[:event_categories]
end

#messageString

Provides the text of this event.

Returns:

  • (String)


50
51
52
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 50

def message
  data[:message]
end

#source_arnString

The Amazon Resource Name (ARN) for the event.

Returns:

  • (String)


62
63
64
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 62

def source_arn
  data[:source_arn]
end

#source_idString Also known as: source_identifier

Returns:

  • (String)


32
33
34
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 32

def source_id
  @source_id
end

#source_typeString

Specifies the source type for this event.

Returns:

  • (String)


44
45
46
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 44

def source_type
  data[:source_type]
end

#wait_until(options = {}, &block) ⇒ Resource

Deprecated.

Use [Aws::RDS::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) {|instance| instance.state.name == 'running' }

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10

    Maximum number of

  • :delay (Integer) — default: 10

    Delay between each

  • :before_attempt (Proc) — default: nil

    Callback

  • :before_wait (Proc) — default: nil

    Callback

Returns:

  • (Resource)

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError)

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError)

    Raised when the resource does not



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event.rb', line 174

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end