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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-docdb/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,
}

Represents the input to DescribeDBEngineVersions.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_parameter_group_family ⇒ String

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

Constraints:

  • If provided, must match an existing `DBParameterGroupFamily`.

^

Returns:

  • (String) 


3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/aws-sdk-docdb/types.rb', line 3171

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

#default_only ⇒ Boolean

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

Returns:

  • (Boolean) 


3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/aws-sdk-docdb/types.rb', line 3171

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

#engine ⇒ String

The database engine to return.

Returns:

  • (String) 


3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/aws-sdk-docdb/types.rb', line 3171

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

#engine_version ⇒ String

The database engine version to return.

Example: `3.6.0`

Returns:

  • (String) 


3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/aws-sdk-docdb/types.rb', line 3171

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

#filters ⇒ Array<Types::Filter>

This parameter is not currently supported.

Returns:



3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/aws-sdk-docdb/types.rb', line 3171

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

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

Returns:

  • (Boolean) 


3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/aws-sdk-docdb/types.rb', line 3171

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

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

  • (Boolean) 


3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/aws-sdk-docdb/types.rb', line 3171

class DescribeDBEngineVersionsMessage < Struct.new(
  :engine,
  :engine_version,
  :db_parameter_group_family,
  :filters,
  :max_records,
  :marker,
  :default_only,
  :list_supported_character_sets,
  :list_supported_timezones)
  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) 


3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/aws-sdk-docdb/types.rb', line 3171

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

#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 (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer) 


3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/aws-sdk-docdb/types.rb', line 3171

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