# frozen_string_literal: true
# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE
module Aws::RDS
class DBEngine
extend Aws::Deprecations
# @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
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
# @!group Read-Only Attributes
# @return [String]
def name
@name
end
# @!endgroup
# @return [Client]
def client
@client
end
# @raise [NotImplementedError]
# @api private
def load
msg = "#load is not implemented, data only available via enumeration"
raise NotImplementedError, msg
end
alias :reload :load
# @api private
# @return [EmptyStructure]
def data
@data
end
# @return [Boolean]
# Returns `true` if this resource is loaded. Accessing attributes or
# {#data} on an unloaded resource will trigger a call to {#load}.
def data_loaded?
!!@data
end
# @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
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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
Aws::Waiters::Waiter.new(options).wait({})
end
end
# @!group Associations
# @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]
def option_group_options(options = {})
batches = Enumerator.new do |y|
options = options.merge(engine_name: @name)
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
@client.describe_option_group_options(options)
end
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
# @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]
def option_groups(options = {})
batches = Enumerator.new do |y|
options = options.merge(engine_name: @name)
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
@client.describe_option_groups(options)
end
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
# @param [String] version
# @return [DBEngineVersion]
def version(version)
DBEngineVersion.new(
engine_name: @name,
version: version,
client: @client
)
end
# @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
# A specific database engine version to return details for.
#
# 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 DB parameter group family.
#
# ^
# @option options [Array<Types::Filter>] :filters
# A filter that specifies one or more DB engine versions to describe.
#
# Supported filters:
#
# * `db-parameter-group-family` - Accepts parameter groups family names.
# The results list only includes information about the DB engine
# versions for these parameter group families.
#
# * `engine` - Accepts engine names. The results list only includes
# information about the DB engine versions for these engines.
#
# * `engine-mode` - Accepts DB engine modes. The results list only
# includes information about the DB engine versions for these engine
# modes. Valid DB engine modes are the following:
#
# * `global`
#
# * `multimaster`
#
# * `parallelquery`
#
# * `provisioned`
#
# * `serverless`
# * `engine-version` - Accepts engine versions. The results list only
# includes information about the DB engine versions for these engine
# versions.
#
# * `status` - Accepts engine version statuses. The results list only
# includes information about the DB engine versions for these
# statuses. Valid statuses are the following:
#
# * `available`
#
# * `deprecated`
# @option options [Boolean] :default_only
# Specifies whether to return only the default version of the specified
# engine or the engine and major version combination.
# @option options [Boolean] :list_supported_character_sets
# Specifies 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.
#
# For RDS Custom, the default is not to list supported character sets.
# If you enable this parameter, RDS Custom returns no results.
# @option options [Boolean] :list_supported_timezones
# Specifies 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.
#
# For RDS Custom, the default is not to list supported time zones. If
# you enable this parameter, RDS Custom returns no results.
# @option options [Boolean] :include_all
# Specifies whether to also list the engine versions that aren't
# available. The default is to list only available engine versions.
# @return [DBEngineVersion::Collection]
def versions(options = {})
batches = Enumerator.new do |y|
options = options.merge(engine: @name)
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
@client.describe_db_engine_versions(options)
end
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
# @deprecated
# @api private
def identifiers
{ name: @name }
end
deprecated(:identifiers)
private
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
class Collection < Aws::Resources::Collection; end
end
end