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

Class: Aws::RDS::DBEngine

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(name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

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

    Parameters:

    • name (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):

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

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

Instance Attribute Details

#nameString (readonly)

Returns:

  • (String)

Instance Method Details

#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


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

Enumerating OptionGroupOption resources.

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

Enumerating OptionGroupOption resources with a limit.

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

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.

  • :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


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

Enumerating OptionGroup resources.

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

Enumerating OptionGroup resources with a limit.

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

  • :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:

See Also:

#version(version) ⇒ DBEngineVersion

Parameters:

Returns:

See Also:

#versions(options = {}) ⇒ Collection<DBEngineVersion>

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

Examples:

Request syntax example with placeholder values


dbengine.versions({
  engine_version: "String",
  db_parameter_group_family: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
  default_only: false,
  list_supported_character_sets: false,
  list_supported_timezones: false,
})

Enumerating Aws::RDS::DBEngineVersion resources.

dbengine.versions.each do |dbengineversion|
  # yields each dbengineversion
end

Enumerating Aws::RDS::DBEngineVersion resources with a limit.

dbengine.versions.limit(10).each do |dbengineversion|
  # yields at most 10 versions
end

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

    Not currently supported.

  • :max_records (Integer)

    The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following 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.

  • :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:

See Also: