Class: Aws::RDS::DBEngine

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
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) 


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

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)
end

Instance Method Details

#client ⇒ Client

Returns:



36
37
38
 
# File 'lib/aws-sdk-rds/db_engine.rb', line 36

def client
  @client
end

#data ⇒ EmptyStructure

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (EmptyStructure) 


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

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



57
58
59
 
# File 'lib/aws-sdk-rds/db_engine.rb', line 57

def data_loaded?
  !!@data
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


219
220
221
 
# File 'lib/aws-sdk-rds/db_engine.rb', line 219

def identifiers
  { name: @name }
end

#load ⇒ Object Also known as: reload

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises:

  • (NotImplementedError) 


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

def load
  msg = "#load is not implemented, data only available via enumeration"
  raise NotImplementedError, msg
end

#name ⇒ String

Returns:

  • (String) 


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

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 is not currently supported.

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/aws-sdk-rds/db_engine.rb', line 81

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. Cannot be supplied together with EngineName or MajorEngineVersion.

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

    This parameter is not 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:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/aws-sdk-rds/db_engine.rb', line 123

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:



144
145
146
147
148
149
150
 
# File 'lib/aws-sdk-rds/db_engine.rb', line 144

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

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:

    • Must be 1 to 255 alphanumeric characters

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

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

    Not currently supported.

  • :default_only (Boolean) —

    Indicates that only the default version of the specified engine or engine and major version combination is returned.

  • :list_supported_character_sets (Boolean) —

    If this parameter is specified 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) —

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

Returns:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/aws-sdk-rds/db_engine.rb', line 197

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