Skip to content

FailoverGlobalClusterMessage

Source code in docs_src/capo_neptune/types/failover_global_cluster_message.py 
15
16
17
18
19
20
21
22
23
24
25
class FailoverGlobalClusterMessage(TypedDict, closed=True):
    global_cluster_identifier: NotRequired[
        "capo_neptune.types.global_cluster_identifier.GlobalClusterIdentifier"
    ]
    """<p>Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over.</p> <p>Constraints: Must match the identifier of an existing Neptune global database.</p>"""
    target_db_cluster_identifier: NotRequired["capo_neptune.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.</p>"""
    allow_data_loss: NotRequired["capo_neptune.types.boolean_optional.BooleanOptional"]
    """<p>Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.</p> <p>If you don't specify <code>AllowDataLoss</code>, the global database cluster operation defaults to a switchover.</p> <p>Constraints: Can't be specified together with the <code>Switchover</code> parameter.</p>"""
    switchover: NotRequired["capo_neptune.types.boolean_optional.BooleanOptional"]
    """<p>Specifies whether to switch over this global database cluster.</p> <p>Constraints: Can't be specified together with the <code>AllowDataLoss</code> parameter.</p>"""

allow_data_loss instance-attribute 

allow_data_loss: NotRequired[BooleanOptional]

Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation.

If you don't specify AllowDataLoss, the global database cluster operation defaults to a switchover.

Constraints: Can't be specified together with the Switchover parameter.

global_cluster_identifier instance-attribute 

global_cluster_identifier: NotRequired[GlobalClusterIdentifier]

Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over.

Constraints: Must match the identifier of an existing Neptune global database.

switchover instance-attribute 

switchover: NotRequired[BooleanOptional]

Specifies whether to switch over this global database cluster.

Constraints: Can't be specified together with the AllowDataLoss parameter.

target_db_cluster_identifier instance-attribute 

target_db_cluster_identifier: NotRequired[String]

The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.