Skip to content

RDS  >  Structures  >  DBEngineVersion

DBEngineVersion

Structure Class

DBEngineVersion dataclass

Bases: _SerdeShape

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

Attributes

create_time class-attribute instance-attribute
create_time: datetime | None = ...

The creation time of the DB engine version.

custom_db_engine_version_manifest class-attribute instance-attribute
custom_db_engine_version_manifest: str | None = ...

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.

database_installation_files class-attribute instance-attribute
database_installation_files: list[str] | None = ...

The 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_name class-attribute instance-attribute
database_installation_files_s3_bucket_name: str | None = ...

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

database_installation_files_s3_prefix class-attribute instance-attribute
database_installation_files_s3_prefix: str | None = ...

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

db_engine_description class-attribute instance-attribute
db_engine_description: str | None = ...

The description of the database engine.

db_engine_media_type class-attribute instance-attribute
db_engine_media_type: str | None = ...

The 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_arn class-attribute instance-attribute
db_engine_version_arn: str | None = ...

The ARN of the custom engine version.

db_engine_version_description class-attribute instance-attribute
db_engine_version_description: str | None = ...

The description of the database engine version.

db_parameter_group_family class-attribute instance-attribute
db_parameter_group_family: str | None = ...

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

default_character_set class-attribute instance-attribute
default_character_set: CharacterSet | None = ...

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

engine class-attribute instance-attribute
engine: str | None = ...

The name of the database engine.

engine_version class-attribute instance-attribute
engine_version: str | None = ...

The version number of the database engine.

exportable_log_types class-attribute instance-attribute
exportable_log_types: list[str] | None = ...

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

failure_reason class-attribute instance-attribute
failure_reason: str | None = ...

The 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).

image class-attribute instance-attribute
image: CustomDBEngineVersionAMI | None = ...

The EC2 image

kms_key_id class-attribute instance-attribute
kms_key_id: str | None = ...

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

major_engine_version class-attribute instance-attribute
major_engine_version: str | None = ...

The major engine version of the CEV.

serverless_v2_features_support class-attribute instance-attribute
serverless_v2_features_support: ServerlessV2FeaturesSupport | None = ...

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

status class-attribute instance-attribute
status: str | None = ...

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

supported_ca_certificate_identifiers class-attribute instance-attribute
supported_ca_certificate_identifiers: list[str] | None = ...

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.

supported_character_sets class-attribute instance-attribute
supported_character_sets: list[CharacterSet] | None = ...

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

supported_engine_modes class-attribute instance-attribute
supported_engine_modes: list[str] | None = ...

A list of the supported DB engine modes.

supported_feature_names class-attribute instance-attribute
supported_feature_names: list[str] | None = ...

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.

supported_nchar_character_sets class-attribute instance-attribute
supported_nchar_character_sets: list[CharacterSet] | None = ...

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

supported_timezones class-attribute instance-attribute
supported_timezones: list[Timezone] | None = ...

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

supports_babelfish class-attribute instance-attribute
supports_babelfish: bool | None = ...

Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

supports_certificate_rotation_without_restart class-attribute instance-attribute
supports_certificate_rotation_without_restart: bool | None = ...

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

supports_global_databases class-attribute instance-attribute
supports_global_databases: bool | None = ...

Indicates whether you can use Aurora global databases with a specific DB engine version.

supports_integrations class-attribute instance-attribute
supports_integrations: bool | None = ...

Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.

supports_limitless_database class-attribute instance-attribute
supports_limitless_database: bool | None = ...

Indicates whether the DB engine version supports Aurora Limitless Database.

supports_local_write_forwarding class-attribute instance-attribute
supports_local_write_forwarding: bool | None = ...

Indicates 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_logs class-attribute instance-attribute
supports_log_exports_to_cloudwatch_logs: bool | None = ...

Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

supports_parallel_query class-attribute instance-attribute
supports_parallel_query: bool | None = ...

Indicates whether you can use Aurora parallel query with a specific DB engine version.

supports_read_replica class-attribute instance-attribute
supports_read_replica: bool | None = ...

Indicates whether the database engine version supports read replicas.

tag_list class-attribute instance-attribute
tag_list: list[Tag] | None = ...

A 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_target class-attribute instance-attribute
valid_upgrade_target: list[UpgradeTarget] | None = ...

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