Skip to content

UpgradeTarget

Source code in docs_src/capo_rds/types/upgrade_target.py
class UpgradeTarget(TypedDict, closed=True):
    engine: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the upgrade target database engine.</p>"""
    engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>The version number of the upgrade target database engine.</p>"""
    description: NotRequired["capo_rds.types.string.String"]
    """<p>The version of the database engine that a DB instance can be upgraded to.</p>"""
    auto_upgrade: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the target version is applied to any source DB instances that have <code>AutoMinorVersionUpgrade</code> set to true.</p> <p>This parameter is dynamic, and is set by RDS.</p>"""
    is_major_version_upgrade: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether upgrading to the target version requires upgrading the major version of the database engine.</p>"""
    supported_engine_modes: NotRequired[
        "capo_rds.types.engine_mode_list.EngineModeList"
    ]
    """<p>A list of the supported DB engine modes for the target engine version.</p>"""
    supports_parallel_query: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether you can use Aurora parallel query with the target engine version.</p>"""
    supports_global_databases: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether you can use Aurora global databases with the target engine version.</p>"""
    supports_babelfish: NotRequired["capo_rds.types.boolean_optional.BooleanOptional"]
    """<p>Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.</p>"""
    supports_limitless_database: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether the DB engine version supports Aurora Limitless Database.</p>"""
    supports_local_write_forwarding: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether the target 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.</p> <p>Valid for: Aurora DB clusters only</p>"""
    supports_integrations: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.</p>"""

auto_upgrade instance-attribute

auto_upgrade: NotRequired[Boolean]

Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

This parameter is dynamic, and is set by RDS.

description instance-attribute

description: NotRequired[String]

The version of the database engine that a DB instance can be upgraded to.

engine instance-attribute

engine: NotRequired[String]

The name of the upgrade target database engine.

engine_version instance-attribute

engine_version: NotRequired[String]

The version number of the upgrade target database engine.

is_major_version_upgrade instance-attribute

is_major_version_upgrade: NotRequired[Boolean]

Indicates whether upgrading to the target version requires upgrading the major version of the database engine.

supported_engine_modes instance-attribute

supported_engine_modes: NotRequired[EngineModeList]

A list of the supported DB engine modes for the target engine version.

supports_babelfish instance-attribute

supports_babelfish: NotRequired[BooleanOptional]

Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.

supports_global_databases instance-attribute

supports_global_databases: NotRequired[BooleanOptional]

Indicates whether you can use Aurora global databases with the target engine version.

supports_integrations instance-attribute

supports_integrations: NotRequired[BooleanOptional]

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

supports_limitless_database instance-attribute

supports_limitless_database: NotRequired[BooleanOptional]

Indicates whether the DB engine version supports Aurora Limitless Database.

supports_local_write_forwarding instance-attribute

supports_local_write_forwarding: NotRequired[BooleanOptional]

Indicates whether the target 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_parallel_query instance-attribute

supports_parallel_query: NotRequired[BooleanOptional]

Indicates whether you can use Aurora parallel query with the target engine version.