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

Class: Aws::RDS::EventCategoryMap

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(source_type, options = {}) ⇒ EventCategoryMap #initialize(options = {}) ⇒ EventCategoryMap

Returns a new instance of EventCategoryMap

Overloads:

  • #initialize(source_type, options = {}) ⇒ EventCategoryMap

    Parameters:

    • source_type (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ EventCategoryMap

    Options Hash (options):

    • :source_type (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_category_map.rb', line 19

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

Instance Method Details

#clientClient

Returns:



42
43
44
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_category_map.rb', line 42

def client
  @client
end

#dataTypes::EventCategoriesMap

Returns the data for this Aws::RDS::EventCategoryMap. Calls Client#describe_event_categories if #data_loaded? is false.

Returns:



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

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.



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

def data_loaded?
  !!@data
end

#event_categoriesArray<String>

The event categories for the specified source type

Returns:

  • (Array<String>)


35
36
37
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_category_map.rb', line 35

def event_categories
  data[:event_categories]
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::RDS::EventCategoryMap. Returns self making it possible to chain methods.

event_category_map.reload.data

Returns:

  • (self)


52
53
54
55
56
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_category_map.rb', line 52

def load
  resp = @client.describe_event_categories(source_type: @name)
  @data = resp.event_categories_map_list[0]
  self
end

#source_typeString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_category_map.rb', line 29

def source_type
  @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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/event_category_map.rb', line 152

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