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

Class: Aws::DocDB::Types::DescribeDBEngineVersionsMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeDBEngineVersionsMessage as input to an Aws::Client method, you can use a vanilla 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,
}

Represents the input to DescribeDBEngineVersions.

Instance Attribute Summary collapse

Instance Attribute Details

#db_parameter_group_familyString

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

Constraints:

  • If provided, must match an existing DBParameterGroupFamily.

^

Returns:

  • (String)

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

#default_onlyBoolean

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

Returns:

  • (Boolean)

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

#engineString

The database engine to return.

Returns:

  • (String)

    The database engine to return.

#engine_versionString

The database engine version to return.

Example: 3.6.0

Returns:

  • (String)

    The database engine version to return.

#filtersArray<Types::Filter>

This parameter is not currently supported.

Returns:

  • (Array<Types::Filter>)

    This parameter is not currently supported.

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

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

    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.

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

    An optional pagination token provided by a previous request.

#max_recordsInteger

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

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer)

    The maximum number of records to include in the response.