DBEngineVersion - Amazon Relational Database Service
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

DBEngineVersion

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

Contents

Note

In the following list, the required parameters are described first.

CreateTime

The creation time of the DB engine version.

Type: Timestamp

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 51000.

Pattern: [\s\S]*

Required: No

DatabaseInstallationFilesS3BucketName

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

Type: String

Required: No

DatabaseInstallationFilesS3Prefix

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

Type: String

Required: No

DBEngineDescription

The description of the database engine.

Type: String

Required: No

DBEngineMediaType

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

Type: String

Required: No

DBEngineVersionArn

The ARN of the custom engine version.

Type: String

Required: No

DBEngineVersionDescription

The description of the database engine version.

Type: String

Required: No

DBParameterGroupFamily

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

Type: String

Required: No

DefaultCharacterSet

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

Type: CharacterSet object

Required: No

Engine

The name of the database engine.

Type: String

Required: No

EngineVersion

The version number of the database engine.

Type: String

Required: No

ExportableLogTypes.member.N

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

Type: Array of strings

Required: No

Image

The EC2 image

Type: CustomDBEngineVersionAMI object

Required: No

KMSKeyId

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

Type: String

Required: No

MajorEngineVersion

The major engine version of the CEV.

Type: String

Required: No

Status

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

Type: String

Required: No

SupportedCACertificateIdentifiers.member.N

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.

Type: Array of strings

Required: No

SupportedCharacterSets.CharacterSet.N

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

Type: Array of CharacterSet objects

Required: No

SupportedEngineModes.member.N

A list of the supported DB engine modes.

Type: Array of strings

Required: No

SupportedFeatureNames.member.N

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

Type: Array of strings

Required: No

SupportedNcharCharacterSets.CharacterSet.N

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

Type: Array of CharacterSet objects

Required: No

SupportedTimezones.Timezone.N

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

Type: Array of Timezone objects

Required: No

SupportsBabelfish

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

Type: Boolean

Required: No

SupportsCertificateRotationWithoutRestart

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

Type: Boolean

Required: No

SupportsGlobalDatabases

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

Type: Boolean

Required: No

SupportsLogExportsToCloudwatchLogs

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

Type: Boolean

Required: No

SupportsParallelQuery

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

Type: Boolean

Required: No

SupportsReadReplica

Indicates whether the database engine version supports read replicas.

Type: Boolean

Required: No

TagList.Tag.N

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Type: Array of Tag objects

Required: No

ValidUpgradeTarget.UpgradeTarget.N

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

Type: Array of UpgradeTarget objects

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: