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

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DescribeDBEngineVersionsMessage

Includes:

Structure

Defined in:

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,
  include_all: false,
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_parameter_group_family ⇒ String

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

• #default_only ⇒ Boolean

  A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

• #engine ⇒ String

  The database engine to return.

• #engine_version ⇒ String

  The database engine version to return.

• #filters ⇒ Array<Types::Filter>

  A filter that specifies one or more DB engine versions to describe.

• #include_all ⇒ Boolean

  A value that indicates whether to include engine versions that aren't available in the list.

• #list_supported_character_sets ⇒ Boolean

  A value that indicates whether to list the supported character sets for each engine version.

• #list_supported_timezones ⇒ Boolean

  A value that indicates whether to list the supported time zones for each engine version.

• #marker ⇒ String

  An optional pagination token provided by a previous request.

• #max_records ⇒ Integer

  The maximum number of records to include in the response.

Instance Attribute Details

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

^

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 10740

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_all)
  SENSITIVE = []
  include Aws::Structure
end

#default_only ⇒ Boolean

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

Returns:

• (Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 10740

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_all)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

The database engine to return.

Valid Values:

• `aurora` (for MySQL 5.6-compatible Aurora)

• `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

• `aurora-postgresql`

• `mariadb`

• `mysql`

• `oracle-ee`

• `oracle-ee-cdb`

• `oracle-se2`

• `oracle-se2-cdb`

• `postgres`

• `sqlserver-ee`

• `sqlserver-se`

• `sqlserver-ex`

• `sqlserver-web`

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 10740

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_all)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The database engine version to return.

Example: `5.1.49`

Returns:

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 10740

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_all)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Array<Types::Filter>

A filter that specifies one or more DB engine versions to describe.

Supported filters:

• `db-parameter-group-family` - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.

• `engine` - Accepts engine names. The results list only includes information about the DB engine versions for these engines.

• `engine-mode` - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:

  • `global`

  • `multimaster`

  • `parallelquery`

  • `provisioned`

  • `serverless`

• `engine-version` - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.

• `status` - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:

  • `available`

  • `deprecated`

Returns:

• (Array<Types::Filter>)

# File 'lib/aws-sdk-rds/types.rb', line 10740

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_all)
  SENSITIVE = []
  include Aws::Structure
end

#include_all ⇒ Boolean

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

Returns:

• (Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 10740

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_all)
  SENSITIVE = []
  include Aws::Structure
end

#list_supported_character_sets ⇒ Boolean

A value that indicates whether to list the supported character sets for each engine version.

If this parameter is enabled and the requested engine supports the `CharacterSetName` parameter for `CreateDBInstance`, the response includes a list of supported character sets for each engine version.

For RDS Custom, the default is not to list supported character sets. If you set `ListSupportedCharacterSets` to `true`, RDS Custom returns no results.

Returns:

• (Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 10740

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_all)
  SENSITIVE = []
  include Aws::Structure
end

#list_supported_timezones ⇒ Boolean

A value that indicates whether to list the supported time zones for each engine version.

If this parameter is enabled and the requested engine supports the `TimeZone` parameter for `CreateDBInstance`, the response includes a list of supported time zones for each engine version.

For RDS Custom, the default is not to list supported time zones. If you set `ListSupportedTimezones` to `true`, RDS Custom returns no results.

Returns:

• (Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 10740

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_all)
  SENSITIVE = []
  include Aws::Structure
end

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

• (String)

# File 'lib/aws-sdk-rds/types.rb', line 10740

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_all)
  SENSITIVE = []
  include Aws::Structure
end

#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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

• (Integer)

# File 'lib/aws-sdk-rds/types.rb', line 10740

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_all)
  SENSITIVE = []
  include Aws::Structure
end