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

Class: Aws::RDS::Types::DescribeDBEngineVersionsMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass DescribeDBEngineVersionsMessage data as a hash:

{
  engine: "String",
  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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#db_parameter_group_familyString

The name of a specific DB parameter group family to return details for.

Constraints:

  • If supplied, must match an existing DBParameterGroupFamily.

^

Returns:

  • (String)


6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6028

class DescribeDBEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_parameter_group_family,
  :filters,
  :max_records,
  :marker,
  :default_only,
  :list_supported_character_sets,
  :list_supported_timezones)
  include Aws::Structure
end

#default_onlyBoolean

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

Returns:

  • (Boolean)


6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6028

class DescribeDBEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_parameter_group_family,
  :filters,
  :max_records,
  :marker,
  :default_only,
  :list_supported_character_sets,
  :list_supported_timezones)
  include Aws::Structure
end

#engineString

The database engine to return.

Returns:

  • (String)


6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6028

class DescribeDBEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_parameter_group_family,
  :filters,
  :max_records,
  :marker,
  :default_only,
  :list_supported_character_sets,
  :list_supported_timezones)
  include Aws::Structure
end

#engine_versionString

The database engine version to return.

Example: 5.1.49

Returns:

  • (String)


6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6028

class DescribeDBEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_parameter_group_family,
  :filters,
  :max_records,
  :marker,
  :default_only,
  :list_supported_character_sets,
  :list_supported_timezones)
  include Aws::Structure
end

#filtersArray<Types::Filter>

Not currently supported.

Returns:



6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6028

class DescribeDBEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_parameter_group_family,
  :filters,
  :max_records,
  :marker,
  :default_only,
  :list_supported_character_sets,
  :list_supported_timezones)
  include Aws::Structure
end

#list_supported_character_setsBoolean

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.

Returns:

  • (Boolean)


6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6028

class DescribeDBEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_parameter_group_family,
  :filters,
  :max_records,
  :marker,
  :default_only,
  :list_supported_character_sets,
  :list_supported_timezones)
  include Aws::Structure
end

#list_supported_timezonesBoolean

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:

  • (Boolean)


6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6028

class DescribeDBEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_parameter_group_family,
  :filters,
  :max_records,
  :marker,
  :default_only,
  :list_supported_character_sets,
  :list_supported_timezones)
  include Aws::Structure
end

#markerString

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:

  • (String)


6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6028

class DescribeDBEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_parameter_group_family,
  :filters,
  :max_records,
  :marker,
  :default_only,
  :list_supported_character_sets,
  :list_supported_timezones)
  include Aws::Structure
end

#max_recordsInteger

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.

Returns:

  • (Integer)


6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6028

class DescribeDBEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_parameter_group_family,
  :filters,
  :max_records,
  :marker,
  :default_only,
  :list_supported_character_sets,
  :list_supported_timezones)
  include Aws::Structure
end