Skip to content

DBEngineVersion

Source code in docs_src/capo_docdb/types/db_engine_version.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class DBEngineVersion(TypedDict, closed=True):
    engine: NotRequired["capo_docdb.types.string.String"]
    """<p>The name of the database engine.</p>"""
    engine_version: NotRequired["capo_docdb.types.string.String"]
    """<p>The version number of the database engine.</p>"""
    db_parameter_group_family: NotRequired["capo_docdb.types.string.String"]
    """<p>The name of the parameter group family for the database engine.</p>"""
    db_engine_description: NotRequired["capo_docdb.types.string.String"]
    """<p>The description of the database engine.</p>"""
    db_engine_version_description: NotRequired["capo_docdb.types.string.String"]
    """<p>The description of the database engine version.</p>"""
    valid_upgrade_target: NotRequired[
        "capo_docdb.types.valid_upgrade_target_list.ValidUpgradeTargetList"
    ]
    """<p>A list of engine versions that this database engine version can be upgraded to.</p>"""
    exportable_log_types: NotRequired["capo_docdb.types.log_type_list.LogTypeList"]
    """<p>The types of logs that the database engine has available for export to Amazon CloudWatch Logs.</p>"""
    supports_log_exports_to_cloudwatch_logs: NotRequired[
        "capo_docdb.types.boolean.Boolean"
    ]
    """<p>A value that indicates whether the engine version supports exporting the log types specified by <code>ExportableLogTypes</code> to CloudWatch Logs.</p>"""
    supported_ca_certificate_identifiers: NotRequired[
        "capo_docdb.types.ca_certificate_identifiers_list.CACertificateIdentifiersList"
    ]
    """<p>A list of the supported CA certificate identifiers.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/devguide/ca_cert_rotation.html">Updating Your Amazon DocumentDB TLS Certificates</a> and <a href="https://docs.aws.amazon.com/documentdb/latest/devguide/security.encryption.ssl.html"> Encrypting Data in Transit</a> in the <i>Amazon DocumentDB Developer Guide</i>.</p>"""
    supports_certificate_rotation_without_restart: NotRequired[
        "capo_docdb.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.</p>"""
    serverless_v2_features_support: NotRequired[
        "capo_docdb.types.serverless_v2_features_support.ServerlessV2FeaturesSupport"
    ]
    """<p>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.</p>"""

db_engine_description instance-attribute 

db_engine_description: NotRequired[String]

The description of the database engine.

db_engine_version_description instance-attribute 

db_engine_version_description: NotRequired[String]

The description of the database engine version.

db_parameter_group_family instance-attribute 

db_parameter_group_family: NotRequired[String]

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

engine instance-attribute 

engine: NotRequired[String]

The name of the database engine.

engine_version instance-attribute 

engine_version: NotRequired[String]

The version number of the database engine.

exportable_log_types instance-attribute 

exportable_log_types: NotRequired[LogTypeList]

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

serverless_v2_features_support instance-attribute 

serverless_v2_features_support: NotRequired[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.

supported_ca_certificate_identifiers instance-attribute 

supported_ca_certificate_identifiers: NotRequired[CACertificateIdentifiersList]

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.

supports_certificate_rotation_without_restart instance-attribute 

supports_certificate_rotation_without_restart: NotRequired[BooleanOptional]

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

supports_log_exports_to_cloudwatch_logs instance-attribute 

supports_log_exports_to_cloudwatch_logs: NotRequired[Boolean]

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

valid_upgrade_target instance-attribute 

valid_upgrade_target: NotRequired[ValidUpgradeTargetList]

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