class Aws::RDS::DBEngine

Public Class Methods

new(*args) click to toggle source

@overload def initialize(name, options = {})

@param [String] name
@option options [Client] :client

@overload def initialize(options = {})

@option options [required, String] :name
@option options [Client] :client
# File lib/aws-sdk-rds/db_engine.rb, line 22
def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = Aws::EmptyStructure.new
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Public Instance Methods

client() click to toggle source

@return [Client]

# File lib/aws-sdk-rds/db_engine.rb, line 40
def client
  @client
end
data() click to toggle source

@api private @return [EmptyStructure]

# File lib/aws-sdk-rds/db_engine.rb, line 54
def data
  @data
end
data_loaded?() click to toggle source

@return [Boolean]

Returns `true` if this resource is loaded.  Accessing attributes or
{#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-rds/db_engine.rb, line 61
def data_loaded?
  !!@data
end
identifiers() click to toggle source

@deprecated @api private

# File lib/aws-sdk-rds/db_engine.rb, line 329
def identifiers
  { name: @name }
end
load() click to toggle source

@raise [NotImplementedError] @api private

# File lib/aws-sdk-rds/db_engine.rb, line 46
def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end
Also aliased as: reload
name() click to toggle source

@return [String]

# File lib/aws-sdk-rds/db_engine.rb, line 33
def name
  @name
end
option_group_options(options = {}) click to toggle source

@example Request syntax with placeholder values

option_group_options = db_engine.option_group_options({
  major_engine_version: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
})

@param [Hash] options ({}) @option options [String] :major_engine_version

If specified, filters the results to include only options for the
specified major engine version.

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@return [OptionGroupOption::Collection]

# File lib/aws-sdk-rds/db_engine.rb, line 182
def option_group_options(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(engine_name: @name)
    resp = @client.describe_option_group_options(options)
    resp.each_page do |page|
      batch = []
      page.data.option_group_options.each do |o|
        batch << OptionGroupOption.new(
          name: o.name,
          data: o,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  OptionGroupOption::Collection.new(batches)
end
option_groups(options = {}) click to toggle source

@example Request syntax with placeholder values

option_groups = db_engine.option_groups({
  option_group_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  major_engine_version: "String",
})

@param [Hash] options ({}) @option options [String] :option_group_name

The name of the option group to describe. Can't be supplied together
with EngineName or MajorEngineVersion.

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@option options [String] :major_engine_version

Filters the list of option groups to only include groups associated
with a specific database engine version. If specified, then EngineName
must also be specified.

@return [OptionGroup::Collection]

# File lib/aws-sdk-rds/db_engine.rb, line 224
def option_groups(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(engine_name: @name)
    resp = @client.describe_option_groups(options)
    resp.each_page do |page|
      batch = []
      page.data.option_groups_list.each do |o|
        batch << OptionGroup.new(
          name: o.option_group_name,
          data: o,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  OptionGroup::Collection.new(batches)
end
reload()
Alias for: load
version(version) click to toggle source

@param [String] version @return [DBEngineVersion]

# File lib/aws-sdk-rds/db_engine.rb, line 245
def version(version)
  DBEngineVersion.new(
    engine_name: @name,
    version: version,
    client: @client
  )
end
versions(options = {}) click to toggle source

@example Request syntax with placeholder values

versions = db_engine.versions({
  engine_version: "String",
  db_parameter_group_family: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  default_only: false,
  list_supported_character_sets: false,
  list_supported_timezones: false,
  include_all: false,
})

@param [Hash] options ({}) @option options [String] :engine_version

The database engine version to return.

Example: `5.1.49`

@option options [String] :db_parameter_group_family

The name of a specific DB parameter group family to return details
for.

Constraints:

* If supplied, must match an existing DBParameterGroupFamily.

^

@option options [Array<Types::Filter>] :filters

This parameter isn't currently supported.

@option options [Boolean] :default_only

A value that indicates whether only the default version of the
specified engine or engine and major version combination is returned.

@option options [Boolean] :list_supported_character_sets

A value that indicates whether to list the supported character sets
for each engine version.

If this parameter is enabled and the requested engine supports the
`CharacterSetName` parameter for `CreateDBInstance`, the response
includes a list of supported character sets for each engine version.

@option options [Boolean] :list_supported_timezones

A value that indicates whether to list the supported time zones for
each engine version.

If this parameter is enabled and the requested engine supports the
`TimeZone` parameter for `CreateDBInstance`, the response includes a
list of supported time zones for each engine version.

@option options [Boolean] :include_all

A value that indicates whether to include engine versions that aren't
available in the list. The default is to list only available engine
versions.

@return [DBEngineVersion::Collection]

# File lib/aws-sdk-rds/db_engine.rb, line 307
def versions(options = {})
  batches = Enumerator.new do |y|
    options = options.merge(engine: @name)
    resp = @client.describe_db_engine_versions(options)
    resp.each_page do |page|
      batch = []
      page.data.db_engine_versions.each do |d|
        batch << DBEngineVersion.new(
          engine_name: @name,
          version: d.engine_version,
          data: d,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  DBEngineVersion::Collection.new(batches)
end
wait_until(options = {}, &block) click to toggle source

@deprecated Use [Aws::RDS::Client] wait_until instead

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

@note The waiting operation is performed on a copy. The original resource

remains unchanged.

## 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) do |instance|
  instance.state.name == 'running'
end

## 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

@yieldparam [Resource] resource to be used in the waiting condition.

@raise [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.

@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is

encountered while polling for a resource that is not expected.

@raise [NotImplementedError] Raised when the resource does not

@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful

# File lib/aws-sdk-rds/db_engine.rb, line 145
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

Private Instance Methods

extract_name(args, options) click to toggle source
# File lib/aws-sdk-rds/db_engine.rb, line 336
def extract_name(args, options)
  value = args[0] || options.delete(:name)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :name"
  else
    msg = "expected :name to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end