Skip to content

GlobalAuroraConfiguration

Source code in docs_src/capo_arc_region_switch/types/global_aurora_configuration.py
class GlobalAuroraConfiguration(TypedDict, closed=True):
    timeout_minutes: "int"
    """<p>The timeout value specified for the configuration.</p>"""
    cross_account_role: NotRequired[
        "capo_arc_region_switch.types.iam_role_arn.IamRoleArn"
    ]
    """<p>The cross account role for the configuration.</p>"""
    external_id: NotRequired["str"]
    """<p>The external ID (secret key) for the configuration.</p>"""
    behavior: "capo_arc_region_switch.types.global_aurora_default_behavior.GlobalAuroraDefaultBehavior"
    """<p>The default behavior for the Aurora global database execution block. Valid values:</p> <ul> <li> <p> <code>switchoverOnly</code> - Calls <code>SwitchoverGlobalCluster</code> for a zero-data-loss switchover during graceful execution.</p> </li> <li> <p> <code>failover</code> - Calls <code>FailoverGlobalCluster</code> with <code>AllowDataLoss</code> set to <code>true</code>. This operation might cause data loss, including during graceful execution.</p> </li> </ul>"""
    ungraceful: NotRequired[
        "capo_arc_region_switch.types.global_aurora_ungraceful.GlobalAuroraUngraceful"
    ]
    """<p>The behavior to use when the plan runs in ungraceful mode. If you omit this value, Region switch uses the value of <code>behavior</code>.</p>"""
    global_cluster_identifier: (
        "capo_arc_region_switch.types.global_cluster_identifier.GlobalClusterIdentifier"
    )
    """<p>The global cluster identifier for a global database.</p>"""
    database_cluster_arns: (
        "capo_arc_region_switch.types.aurora_cluster_arns.AuroraClusterArns"
    )
    """<p>The database cluster Amazon Resource Names (ARNs) for a global database.</p>"""

behavior instance-attribute

The default behavior for the Aurora global database execution block. Valid values:

  • switchoverOnly - Calls SwitchoverGlobalCluster for a zero-data-loss switchover during graceful execution.

  • failover - Calls FailoverGlobalCluster with AllowDataLoss set to true. This operation might cause data loss, including during graceful execution.

cross_account_role instance-attribute

cross_account_role: NotRequired[IamRoleArn]

The cross account role for the configuration.

database_cluster_arns instance-attribute

database_cluster_arns: AuroraClusterArns

The database cluster Amazon Resource Names (ARNs) for a global database.

external_id instance-attribute

external_id: NotRequired[str]

The external ID (secret key) for the configuration.

global_cluster_identifier instance-attribute

global_cluster_identifier: GlobalClusterIdentifier

The global cluster identifier for a global database.

timeout_minutes instance-attribute

timeout_minutes: int

The timeout value specified for the configuration.

ungraceful instance-attribute

ungraceful: NotRequired[GlobalAuroraUngraceful]

The behavior to use when the plan runs in ungraceful mode. If you omit this value, Region switch uses the value of behavior.