You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::DBEngineVersion

Inherits:
Aws::Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Aws::Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Aws::Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Aws::Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(engine_name, version, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(engine_name, version, options = {}) ⇒ Object

    Parameters:

    • engine_name (String)
    • version (String)

    Options Hash (options):

    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :engine_name (required, String)
    • :version (required, String)
    • :client (Client)

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#db_engine_descriptionString (readonly)

The description of the database engine.

Returns:

  • (String)

    The description of the database engine.

#db_engine_version_descriptionString (readonly)

The description of the database engine version.

Returns:

  • (String)

    The description of the database engine version.

#db_parameter_group_familyString (readonly)

The name of the DB parameter group family for the database engine.

Returns:

  • (String)

    The name of the DB parameter group family for the database engine.

#default_character_setTypes::CharacterSet (readonly)

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

Returns:

  • (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_nameString (readonly)

Returns:

  • (String)

#engine_versionString (readonly)

The version number of the database engine.

Returns:

  • (String)

    The version number of the database engine.

#supported_character_setsArray<Types::CharacterSet> (readonly)

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.

Returns:

  • (Array<Types::CharacterSet>)

    A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.

#supported_timezonesArray<Types::Timezone> (readonly)

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

Returns:

  • (Array<Types::Timezone>)

    A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

#valid_upgrade_targetArray<Types::UpgradeTarget> (readonly)

A list of engine versions that this database engine version can be upgraded to.

Returns:

  • (Array<Types::UpgradeTarget>)

    A list of engine versions that this database engine version can be upgraded to.

#versionString (readonly)

Returns:

  • (String)

Instance Method Details

#engineDBEngine

Returns:

#option_group_options(options = {}) ⇒ Collection<OptionGroupOption>

Returns a Collection of OptionGroupOption resources. No API requests are made until you call an enumerable method on the collection. Client#describe_option_group_options will be called multiple times until every OptionGroupOption has been yielded.

Examples:

Request syntax example with placeholder values


dbengineversion.option_group_options({
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
})

Enumerating OptionGroupOption resources.

dbengineversion.option_group_options.each do |optiongroupoption|
  # yields each optiongroupoption
end

Enumerating OptionGroupOption resources with a limit.

dbengineversion.option_group_options.limit(10).each do |optiongroupoption|
  # yields at most 10 option_group_options
end

Options Hash (options):

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

    This parameter is not currently supported.

  • :max_records (Integer)

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • :marker (String)

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

See Also:

#option_groups(options = {}) ⇒ Collection<OptionGroup>

Returns a Collection of OptionGroup resources. No API requests are made until you call an enumerable method on the collection. Client#describe_option_groups will be called multiple times until every OptionGroup has been yielded.

Examples:

Request syntax example with placeholder values


dbengineversion.option_groups({
  option_group_name: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  marker: "String",
  max_records: 1,
})

Enumerating OptionGroup resources.

dbengineversion.option_groups.each do |optiongroup|
  # yields each optiongroup
end

Enumerating OptionGroup resources with a limit.

dbengineversion.option_groups.limit(10).each do |optiongroup|
  # yields at most 10 option_groups
end

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.

  • :marker (String)

    An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • :max_records (Integer)

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: Minimum 20, maximum 100.

Returns:

See Also:

#parameter_group_familyDBParameterGroupFamily?

Returns: