db_engine_versions

Creates, updates, deletes, gets or lists a db_engine_versions resource.

Overview

Name	db_engine_versions
Type	Resource
Id	aws.docdb.db_engine_versions

Fields

The following fields are returned by SELECT queries:

describe_db_engine_versions

Name	Datatype	Description
db_engine_description	string	The description of the database engine.
db_engine_version_description	string	The description of the database engine version.
db_parameter_group_family	string	The name of the parameter group family for the database engine.
engine	string	The name of the database engine.
engine_version	string	The version number of the database engine.
exportable_log_types	string	The types of logs that the database engine has available for export to Amazon CloudWatch Logs.
serverless_v2_features_support	string	Specifies any Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions. You can test the values of this attribute when deciding which Amazon DocumentDB version to use in a new or upgraded cluster. You can also retrieve the version of an existing cluster and check whether that version supports certain Amazon DocumentDB Serverless features before you attempt to use those features.
supported_ca_certificate_identifiers	string	A list of the supported CA certificate identifiers. For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
supports_certificate_rotation_without_restart	boolean	Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
supports_log_exports_to_cloudwatch_logs	boolean	A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
valid_upgrade_target	string	A list of engine versions that this database engine version can be upgraded to.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_db_engine_versions	select	region	Engine, EngineVersion, DBParameterGroupFamily, Filters, MaxRecords, Marker, DefaultOnly, ListSupportedCharacterSets, ListSupportedTimezones	Returns a list of the available engines.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
DBParameterGroupFamily	string	The name of a specific parameter group family to return details for. Constraints: If provided, must match an existing DBParameterGroupFamily.
DefaultOnly	boolean	Indicates that only the default version of the specified engine or engine and major version combination is returned.
Engine	string	The database engine to return.
EngineVersion	string	The database engine version to return. Example: 3.6.0
Filters	array	This parameter is not currently supported.
ListSupportedCharacterSets	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.
ListSupportedTimezones	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.
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.
MaxRecords	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.

SELECT examples

describe_db_engine_versions

Returns a list of the available engines.

SELECT
db_engine_description,
db_engine_version_description,
db_parameter_group_family,
engine,
engine_version,
exportable_log_types,
serverless_v2_features_support,
supported_ca_certificate_identifiers,
supports_certificate_rotation_without_restart,
supports_log_exports_to_cloudwatch_logs,
valid_upgrade_target
FROM aws.docdb.db_engine_versions
WHERE region = '{{ region }}' -- required
AND Engine = '{{ Engine }}'
AND EngineVersion = '{{ EngineVersion }}'
AND DBParameterGroupFamily = '{{ DBParameterGroupFamily }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
AND DefaultOnly = '{{ DefaultOnly }}'
AND ListSupportedCharacterSets = '{{ ListSupportedCharacterSets }}'
AND ListSupportedTimezones = '{{ ListSupportedTimezones }}'
;