DBEngineVersion - Amazon DocumentDB
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

Detailed information about an engine version.

Contents

Note

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

DBEngineDescription

The description of the database engine.

Type: String

Required: No

DBEngineVersionDescription

The description of the database engine version.

Type: String

Required: No

DBParameterGroupFamily

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

Type: String

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

Type: Array of strings

Required: No

ServerlessV2FeaturesSupport

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.

Type: ServerlessV2FeaturesSupport object

Required: No

SupportedCACertificateIdentifiers.member.N

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.

Type: Array of strings

Required: No

SupportsCertificateRotationWithoutRestart

Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

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

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: