db_engine_versions
Creates, updates, deletes, gets or lists a db_engine_versions resource.
Overview
| Name | db_engine_versions |
| Type | Resource |
| Id | aws.neptune.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 DB parameter group family for the database engine. |
default_character_set | string | (Not supported by Neptune) |
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 CloudWatch Logs. |
supported_character_sets | string | (Not supported by Neptune) |
supported_timezones | string | A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action. |
supports_global_databases | boolean | A value that indicates whether you can use Aurora global databases with a specific DB engine version. |
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. |
supports_read_replica | boolean | Indicates whether the database engine version supports read replicas. |
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 DB 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 DB parameter group family to return details for. Constraints: If supplied, 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: 5.1.49 |
Filters | array | 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 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. |
SELECT examples
- describe_db_engine_versions
Returns a list of the available DB engines.
SELECT
db_engine_description,
db_engine_version_description,
db_parameter_group_family,
default_character_set,
engine,
engine_version,
exportable_log_types,
supported_character_sets,
supported_timezones,
supports_global_databases,
supports_log_exports_to_cloudwatch_logs,
supports_read_replica,
valid_upgrade_target
FROM aws.neptune.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 }}'
;