Skip to main content

db_engine_versions

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

Overview​

Namedb_engine_versions
TypeResource
Idaws.rds.db_engine_versions

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
create_timestringThe creation time of the DB engine version.
custom_db_engine_version_manifeststringJSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide.
db_engine_descriptionstringThe description of the database engine.
db_engine_media_typestringThe source of the installation media for this engine version. A value of Customer Provided indicates that the engine version was created from customer-supplied installation media using CreateCustomDBEngineVersion. Applicable to RDS Custom for SQL Server and to RDS for SQL Server engine versions (sqlserver-ee and sqlserver-se with the bring-your-own-media license model, and sqlserver-dev-ee).
db_engine_version_arnstringThe ARN of the custom engine version.
db_engine_version_descriptionstringThe description of the database engine version.
db_parameter_group_familystringThe name of the DB parameter group family for the database engine.
database_installation_filesstringThe database installation files (ISO and EXE) that were uploaded to Amazon S3 and used to import the database engine version to Amazon RDS. Returned for RDS for SQL Server engine versions (sqlserver-ee, sqlserver-se, and sqlserver-dev-ee) created from customer-supplied installation media.
database_installation_files_s3_bucket_namestringThe name of the Amazon S3 bucket that contains your database installation files.
database_installation_files_s3_prefixstringThe Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
default_character_setstringThe default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
enginestringThe name of the database engine.
engine_versionstringThe version number of the database engine.
exportable_log_typesstringThe types of logs that the database engine has available for export to CloudWatch Logs.
failure_reasonstringThe reason that the custom engine version creation failed with an incompatible-installation-media status. Applicable to RDS for SQL Server engine versions (sqlserver-ee, sqlserver-se, and sqlserver-dev-ee).
imagestringThe EC2 image
kms_key_idstringThe Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
major_engine_versionstringThe major engine version of the CEV.
serverless_v2_features_supportstringSpecifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
statusstringThe status of the DB engine version, either available or deprecated.
supported_ca_certificate_identifiersstringA list of the supported CA certificate identifiers. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
supported_character_setsstringA list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
supported_engine_modesstringA list of the supported DB engine modes.
supported_feature_namesstringA list of features supported by the DB engine. The supported features vary by DB engine and DB engine version. To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command: aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version> For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command: aws rds describe-db-engine-versions --engine postgres --engine-version 13.3 The supported features are listed under SupportedFeatureNames in the output.
supported_nchar_character_setsstringA list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
supported_timezonesstringA list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
supports_babelfishbooleanIndicates whether the engine version supports Babelfish for Aurora PostgreSQL.
supports_certificate_rotation_without_restartbooleanIndicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
supports_global_databasesbooleanIndicates whether you can use Aurora global databases with a specific DB engine version.
supports_integrationsbooleanIndicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
supports_limitless_databasebooleanIndicates whether the DB engine version supports Aurora Limitless Database.
supports_local_write_forwardingbooleanIndicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only
supports_log_exports_to_cloudwatch_logsbooleanIndicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
supports_parallel_querybooleanIndicates whether you can use Aurora parallel query with a specific DB engine version.
supports_read_replicabooleanIndicates whether the database engine version supports read replicas.
tag_liststringA list of tags. For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
valid_upgrade_targetstringA list of engine versions that this database engine version can be upgraded to.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_db_engine_versionsselectregionEngine, EngineVersion, DBParameterGroupFamily, Filters, MaxRecords, Marker, DefaultOnly, ListSupportedCharacterSets, ListSupportedTimezones, IncludeAllDescribes the properties of specific versions of DB engines.
create_custom_db_engine_versioninsertEngineVersion, regionEngine, DatabaseInstallationFilesS3BucketName, DatabaseInstallationFilesS3Prefix, DatabaseInstallationFiles, ImageId, KMSKeyId, SourceCustomDbEngineVersionIdentifier, UseAwsProvidedLatestImage, Description, Manifest, TagsCreates a custom DB engine version (CEV).
modify_custom_db_engine_versionupdateEngineVersion, regionEngine, Description, StatusModifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event. For more information, see Modifying CEV status in the Amazon RDS User Guide.
delete_custom_db_engine_versiondeleteEngineVersion, regionEngineDeletes a custom engine version. To run this command, make sure you meet the following prerequisites: The CEV must not be the default for RDS Custom. If it is, change the default before running this command. The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance. Typically, deletion takes a few minutes. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event. For more information, see Deleting a CEV in the Amazon RDS User Guide.

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.

NameDatatypeDescription
EngineVersionstringThe custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
regionstringAWS region (default: us-east-1)
DBParameterGroupFamilystringThe name of a specific DB parameter group family to return details for. Constraints: If supplied, must match an existing DB parameter group family.
DatabaseInstallationFilesarrayThe database installation files (ISO and EXE) uploaded to Amazon S3 for your database engine version to import to Amazon RDS. For RDS for SQL Server Bring Your Own Media (sqlserver-ee, sqlserver-se), provide the SQL Server RTM ISO file once per major version and edition combination. Minor versions reuse the same file.
DatabaseInstallationFilesS3BucketNamestringThe name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.
DatabaseInstallationFilesS3PrefixstringThe Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.
DefaultOnlybooleanSpecifies whether to return only the default version of the specified engine or the engine and major version combination.
DescriptionstringAn optional description of your CEV.
EnginestringThe database engine. RDS Custom for Oracle supports the following values: custom-oracle-ee custom-oracle-ee-cdb custom-oracle-se2 custom-oracle-se2-cdb RDS Custom for SQL Server supports the following values: custom-sqlserver-ee custom-sqlserver-se custom-sqlserver-web custom-sqlserver-dev RDS for SQL Server supports the following values: sqlserver-ee (Bring Your Own Media) sqlserver-se (Bring Your Own Media) sqlserver-dev-ee
EngineVersionstringA specific database engine version to return details for. Example: 5.1.49
FiltersarrayA 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
ImageIdstringThe ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
IncludeAllbooleanSpecifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
KMSKeyIdstringThe Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide. You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
ListSupportedCharacterSetsbooleanSpecifies 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 enable this parameter, RDS Custom returns no results.
ListSupportedTimezonesbooleanSpecifies 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 enable this parameter, RDS Custom returns no results.
ManifeststringThe CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. The following JSON fields are valid: MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. databaseInstallationFileNames Ordered list of installation files for the CEV. opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. psuRuPatchFileNames The PSU and RU patches for this CEV. OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. For more information, see Creating the CEV manifest in the Amazon RDS User Guide.
MarkerstringAn 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.
MaxRecordsintegerThe 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.
SourceCustomDbEngineVersionIdentifierstringThe ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either Source or UseAwsProvidedLatestImage. You can't specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier.
StatusstringThe availability status to be assigned to the CEV. Valid values are as follows: available You can use this CEV to create a new RDS Custom DB instance. inactive You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV. You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
Tagsarray
UseAwsProvidedLatestImagebooleanSpecifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify ImageId.

SELECT examples​

Describes the properties of specific versions of DB engines.

SELECT
create_time,
custom_db_engine_version_manifest,
db_engine_description,
db_engine_media_type,
db_engine_version_arn,
db_engine_version_description,
db_parameter_group_family,
database_installation_files,
database_installation_files_s3_bucket_name,
database_installation_files_s3_prefix,
default_character_set,
engine,
engine_version,
exportable_log_types,
failure_reason,
image,
kms_key_id,
major_engine_version,
serverless_v2_features_support,
status,
supported_ca_certificate_identifiers,
supported_character_sets,
supported_engine_modes,
supported_feature_names,
supported_nchar_character_sets,
supported_timezones,
supports_babelfish,
supports_certificate_rotation_without_restart,
supports_global_databases,
supports_integrations,
supports_limitless_database,
supports_local_write_forwarding,
supports_log_exports_to_cloudwatch_logs,
supports_parallel_query,
supports_read_replica,
tag_list,
valid_upgrade_target
FROM aws.rds.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 }}'
AND IncludeAll = '{{ IncludeAll }}'
;

INSERT examples​

Creates a custom DB engine version (CEV).

INSERT INTO aws.rds.db_engine_versions (
EngineVersion,
region,
Engine,
DatabaseInstallationFilesS3BucketName,
DatabaseInstallationFilesS3Prefix,
DatabaseInstallationFiles,
ImageId,
KMSKeyId,
SourceCustomDbEngineVersionIdentifier,
UseAwsProvidedLatestImage,
Description,
Manifest,
Tags
)
SELECT 
'{{ EngineVersion }}',
'{{ region }}',
'{{ Engine }}',
'{{ DatabaseInstallationFilesS3BucketName }}',
'{{ DatabaseInstallationFilesS3Prefix }}',
'{{ DatabaseInstallationFiles }}',
'{{ ImageId }}',
'{{ KMSKeyId }}',
'{{ SourceCustomDbEngineVersionIdentifier }}',
'{{ UseAwsProvidedLatestImage }}',
'{{ Description }}',
'{{ Manifest }}',
'{{ Tags }}'
RETURNING
create_time,
custom_db_engine_version_manifest,
db_engine_description,
db_engine_media_type,
db_engine_version_arn,
db_engine_version_description,
db_parameter_group_family,
database_installation_files,
database_installation_files_s3_bucket_name,
database_installation_files_s3_prefix,
default_character_set,
engine,
engine_version,
exportable_log_types,
failure_reason,
image,
kms_key_id,
major_engine_version,
serverless_v2_features_support,
status,
supported_ca_certificate_identifiers,
supported_character_sets,
supported_engine_modes,
supported_feature_names,
supported_nchar_character_sets,
supported_timezones,
supports_babelfish,
supports_certificate_rotation_without_restart,
supports_global_databases,
supports_integrations,
supports_limitless_database,
supports_local_write_forwarding,
supports_log_exports_to_cloudwatch_logs,
supports_parallel_query,
supports_read_replica,
tag_list,
valid_upgrade_target
;

UPDATE examples​

Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event. For more information, see Modifying CEV status in the Amazon RDS User Guide.

UPDATE aws.rds.db_engine_versions
SET 
-- No updatable properties
WHERE 
EngineVersion = '{{ EngineVersion }}' --required
AND region = '{{ region }}' --required
AND Engine = '{{ Engine}}'
AND Description = '{{ Description}}'
AND Status = '{{ Status}}'
RETURNING
create_time,
custom_db_engine_version_manifest,
db_engine_description,
db_engine_media_type,
db_engine_version_arn,
db_engine_version_description,
db_parameter_group_family,
database_installation_files,
database_installation_files_s3_bucket_name,
database_installation_files_s3_prefix,
default_character_set,
engine,
engine_version,
exportable_log_types,
failure_reason,
image,
kms_key_id,
major_engine_version,
serverless_v2_features_support,
status,
supported_ca_certificate_identifiers,
supported_character_sets,
supported_engine_modes,
supported_feature_names,
supported_nchar_character_sets,
supported_timezones,
supports_babelfish,
supports_certificate_rotation_without_restart,
supports_global_databases,
supports_integrations,
supports_limitless_database,
supports_local_write_forwarding,
supports_log_exports_to_cloudwatch_logs,
supports_parallel_query,
supports_read_replica,
tag_list,
valid_upgrade_target;

DELETE examples​

Deletes a custom engine version. To run this command, make sure you meet the following prerequisites: The CEV must not be the default for RDS Custom. If it is, change the default before running this command. The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance. Typically, deletion takes a few minutes. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event. For more information, see Deleting a CEV in the Amazon RDS User Guide.

DELETE FROM aws.rds.db_engine_versions
WHERE EngineVersion = '{{ EngineVersion }}' --required
AND region = '{{ region }}' --required
AND Engine = '{{ Engine }}'
;
Last updated on