Class: Aws::RDS::DBEngineVersion
- Inherits:
-
Object
- Object
- Aws::RDS::DBEngineVersion
- Extended by:
- Deprecations
- Defined in:
- lib/aws-sdk-rds/db_engine_version.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#db_engine_description ⇒ String
The description of the database engine.
-
#db_engine_version_description ⇒ String
The description of the database engine version.
-
#db_parameter_group_family ⇒ String
The name of the DB parameter group family for the database engine.
-
#default_character_set ⇒ Types::CharacterSet
The default character set for new instances of this engine version, if the ‘CharacterSetName` parameter of the CreateDBInstance API is not specified.
- #engine_name ⇒ String (also: #engine)
-
#supported_character_sets ⇒ Array<Types::CharacterSet>
A list of the character sets supported by this engine for the ‘CharacterSetName` parameter of the `CreateDBInstance` action.
-
#supported_timezones ⇒ Array<Types::Timezone>
A list of the time zones supported by this engine for the ‘Timezone` parameter of the `CreateDBInstance` action.
-
#valid_upgrade_target ⇒ Array<Types::UpgradeTarget>
A list of engine versions that this database engine version can be upgraded to.
- #version ⇒ String (also: #engine_version)
Associations collapse
- #identifiers ⇒ Object deprecated private Deprecated.
- #option_group_options(options = {}) ⇒ OptionGroupOption::Collection
- #option_groups(options = {}) ⇒ OptionGroup::Collection
- #parameter_group_family ⇒ DBParameterGroupFamily?
Instance Method Summary collapse
- #client ⇒ Client
-
#data ⇒ Types::DBEngineVersion
Returns the data for this DBEngineVersion.
-
#data_loaded? ⇒ Boolean
Returns ‘true` if this resource is loaded.
-
#initialize(*args) ⇒ DBEngineVersion
constructor
A new instance of DBEngineVersion.
-
#load ⇒ self
(also: #reload)
Loads, or reloads #data for the current DBEngineVersion.
Constructor Details
#initialize(engine_name, version, options = {}) ⇒ DBEngineVersion #initialize(options = {}) ⇒ DBEngineVersion
Returns a new instance of DBEngineVersion.
21 22 23 24 25 26 27 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 21 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @engine_name = extract_engine_name(args, ) @version = extract_version(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() end |
Instance Method Details
#client ⇒ Client
93 94 95 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 93 def client @client end |
#data ⇒ Types::DBEngineVersion
Returns the data for this Aws::RDS::DBEngineVersion. Calls Client#describe_db_engine_versions if #data_loaded? is ‘false`.
116 117 118 119 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 116 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
124 125 126 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 124 def data_loaded? !!@data end |
#db_engine_description ⇒ String
The description of the database engine.
51 52 53 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 51 def db_engine_description data.db_engine_description end |
#db_engine_version_description ⇒ String
The description of the database engine version.
57 58 59 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 57 def db_engine_version_description data.db_engine_version_description end |
#db_parameter_group_family ⇒ String
The name of the DB parameter group family for the database engine.
45 46 47 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 45 def db_parameter_group_family data.db_parameter_group_family end |
#default_character_set ⇒ Types::CharacterSet
The default character set for new instances of this engine version, if the ‘CharacterSetName` parameter of the CreateDBInstance API is not specified.
65 66 67 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 65 def default_character_set data.default_character_set end |
#engine_name ⇒ String Also known as: engine
32 33 34 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 32 def engine_name @engine_name 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.
228 229 230 231 232 233 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 228 def identifiers { engine_name: @engine_name, version: @version } end |
#load ⇒ self Also known as: reload
Loads, or reloads #data for the current Aws::RDS::DBEngineVersion. Returns ‘self` making it possible to chain methods.
db_engine_version.reload.data
103 104 105 106 107 108 109 110 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 103 def load resp = @client.describe_db_engine_versions( engine: @engine_name, engine_version: @version ) @data = resp.db_engine_versions[0] self end |
#option_group_options(options = {}) ⇒ OptionGroupOption::Collection
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 152 def ( = {}) batches = Enumerator.new do |y| = .merge( engine_name: @engine, major_engine_version: @version ) resp = @client.() resp.each_page do |page| batch = [] page.data..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
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 192 def option_groups( = {}) batches = Enumerator.new do |y| = .merge( engine_name: @engine, major_engine_version: @version ) resp = @client.describe_option_groups() 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 |
#parameter_group_family ⇒ DBParameterGroupFamily?
215 216 217 218 219 220 221 222 223 224 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 215 def parameter_group_family if data.db_parameter_group_family DBParameterGroupFamily.new( name: data.db_parameter_group_family, client: @client ) else nil end end |
#supported_character_sets ⇒ Array<Types::CharacterSet>
A list of the character sets supported by this engine for the ‘CharacterSetName` parameter of the `CreateDBInstance` action.
72 73 74 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 72 def supported_character_sets data.supported_character_sets end |
#supported_timezones ⇒ Array<Types::Timezone>
A list of the time zones supported by this engine for the ‘Timezone` parameter of the `CreateDBInstance` action.
86 87 88 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 86 def supported_timezones data.supported_timezones end |
#valid_upgrade_target ⇒ Array<Types::UpgradeTarget>
A list of engine versions that this database engine version can be upgraded to.
79 80 81 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 79 def valid_upgrade_target data.valid_upgrade_target end |
#version ⇒ String Also known as: engine_version
38 39 40 |
# File 'lib/aws-sdk-rds/db_engine_version.rb', line 38 def version @version end |