Documentation

This data type is used as a response element in the action DescribeDBEngineVersions.

See: newDBEngineVersion smart constructor.

Create a value of DBEngineVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createTime:DBEngineVersion', dbEngineVersion_createTime - The creation time of the DB engine version.

$sel:customDBEngineVersionManifest:DBEngineVersion', dbEngineVersion_customDBEngineVersionManifest - JSON 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.

$sel:dbEngineDescription:DBEngineVersion', dbEngineVersion_dbEngineDescription - The description of the database engine.

$sel:dbEngineMediaType:DBEngineVersion', dbEngineVersion_dbEngineMediaType - A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

$sel:dbEngineVersionArn:DBEngineVersion', dbEngineVersion_dbEngineVersionArn - The ARN of the custom engine version.

$sel:dbEngineVersionDescription:DBEngineVersion', dbEngineVersion_dbEngineVersionDescription - The description of the database engine version.

$sel:dbParameterGroupFamily:DBEngineVersion', dbEngineVersion_dbParameterGroupFamily - The name of the DB parameter group family for the database engine.

$sel:databaseInstallationFilesS3BucketName:DBEngineVersion', dbEngineVersion_databaseInstallationFilesS3BucketName - The name of the Amazon S3 bucket that contains your database installation files.

$sel:databaseInstallationFilesS3Prefix:DBEngineVersion', dbEngineVersion_databaseInstallationFilesS3Prefix - The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

$sel:defaultCharacterSet:DBEngineVersion', dbEngineVersion_defaultCharacterSet - The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

DBEngineVersion, dbEngineVersion_engine - The name of the database engine.

DBEngineVersion, dbEngineVersion_engineVersion - The version number of the database engine.

$sel:exportableLogTypes:DBEngineVersion', dbEngineVersion_exportableLogTypes - The types of logs that the database engine has available for export to CloudWatch Logs.

$sel:image:DBEngineVersion', dbEngineVersion_image - The EC2 image

$sel:kmsKeyId:DBEngineVersion', dbEngineVersion_kmsKeyId - The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

$sel:majorEngineVersion:DBEngineVersion', dbEngineVersion_majorEngineVersion - The major engine version of the CEV.

DBEngineVersion, dbEngineVersion_status - The status of the DB engine version, either available or deprecated.

$sel:supportedCACertificateIdentifiers:DBEngineVersion', dbEngineVersion_supportedCACertificateIdentifiers - A 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.

$sel:supportedCharacterSets:DBEngineVersion', dbEngineVersion_supportedCharacterSets - A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

DBEngineVersion, dbEngineVersion_supportedEngineModes - A list of the supported DB engine modes.

$sel:supportedFeatureNames:DBEngineVersion', dbEngineVersion_supportedFeatureNames - A 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.

$sel:supportedNcharCharacterSets:DBEngineVersion', dbEngineVersion_supportedNcharCharacterSets - A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

$sel:supportedTimezones:DBEngineVersion', dbEngineVersion_supportedTimezones - A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

DBEngineVersion, dbEngineVersion_supportsBabelfish - A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

$sel:supportsCertificateRotationWithoutRestart:DBEngineVersion', dbEngineVersion_supportsCertificateRotationWithoutRestart - A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

DBEngineVersion, dbEngineVersion_supportsGlobalDatabases - A value that indicates whether you can use Aurora global databases with a specific DB engine version.

$sel:supportsLogExportsToCloudwatchLogs:DBEngineVersion', dbEngineVersion_supportsLogExportsToCloudwatchLogs - A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

DBEngineVersion, dbEngineVersion_supportsParallelQuery - A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

$sel:supportsReadReplica:DBEngineVersion', dbEngineVersion_supportsReadReplica - Indicates whether the database engine version supports read replicas.

$sel:tagList:DBEngineVersion', dbEngineVersion_tagList - Undocumented member.

$sel:validUpgradeTarget:DBEngineVersion', dbEngineVersion_validUpgradeTarget - A list of engine versions that this database engine version can be upgraded to.

The creation time of the DB engine version.

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

The description of the database engine.

A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.

The ARN of the custom engine version.

The description of the database engine version.

The name of the DB parameter group family for the database engine.

The name of the Amazon S3 bucket that contains your database installation files.

The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

The name of the database engine.

The version number of the database engine.

The types of logs that the database engine has available for export to CloudWatch Logs.

The EC2 image

The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.

The major engine version of the CEV.

The status of the DB engine version, either available or deprecated.

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

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

A list of the supported DB engine modes.

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

A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

A value that indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

A value that indicates whether you can use Aurora global databases with a specific DB engine version.

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

A value that indicates whether you can use Aurora parallel query with a specific DB engine version.

Indicates whether the database engine version supports read replicas.

Undocumented member.

A list of engine versions that this database engine version can be upgraded to.