Class: Aws::RDS::DBEngine

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ DBEngine #initialize(options = {}) ⇒ DBEngine

Returns a new instance of DBEngine.

Overloads:

  • #initialize(name, options = {}) ⇒ DBEngine

    Parameters:

    • name (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ DBEngine

    Options Hash (options):

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


22
23
24
25
26
27
28
# File 'gems/aws-sdk-rds/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

Instance Method Details

#clientClient

Returns:



40
41
42
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_engine.rb', line 40

def client
  @client
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.



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

def data_loaded?
  !!@data
end

#nameString

Returns:

  • (String)


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

def name
  @name
end

#option_group_options(options = {}) ⇒ OptionGroupOption::Collection

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :major_engine_version (String)

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

  • :filters (Array<Types::Filter>)

    This parameter isn't currently supported.

Returns:



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
# File 'gems/aws-sdk-rds/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 = {}) ⇒ OptionGroup::Collection

Examples:

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",
})

Parameters:

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

    ({})

Options Hash (options):

  • :option_group_name (String)

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

  • :filters (Array<Types::Filter>)

    This parameter isn't currently supported.

  • :major_engine_version (String)

    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.

Returns:



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'gems/aws-sdk-rds/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

#version(version) ⇒ DBEngineVersion

Parameters:

  • version (String)

Returns:



245
246
247
248
249
250
251
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/db_engine.rb', line 245

def version(version)
  DBEngineVersion.new(
    engine_name: @name,
    version: version,
    client: @client
  )
end

#versions(options = {}) ⇒ DBEngineVersion::Collection

Examples:

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,
})

Parameters:

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

    ({})

Options Hash (options):

  • :engine_version (String)

    The database engine version to return.

    Example: 5.1.49

  • :db_parameter_group_family (String)

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

    Constraints:

    • If supplied, must match an existing DBParameterGroupFamily.

    ^

  • :filters (Array<Types::Filter>)

    This parameter isn't currently supported.

  • :default_only (Boolean)

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

  • :list_supported_character_sets (Boolean)

    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.

  • :list_supported_timezones (Boolean)

    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.

  • :include_all (Boolean)

    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.

Returns:



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'gems/aws-sdk-rds/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 = {}) {|resource| ... } ⇒ 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) 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

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

Yield Parameters:

  • resource (Resource)

    to be used in the waiting condition.

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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'gems/aws-sdk-rds/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