Skip to content

FailoverDBClusterMessage

Source code in docs_src/capo_docdb/types/failover_db_cluster_message.py 
13
14
15
16
17
class FailoverDBClusterMessage(TypedDict, closed=True):
    db_cluster_identifier: NotRequired["capo_docdb.types.string.String"]
    """<p>A cluster identifier to force a failover for. This parameter is not case sensitive.</p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <code>DBCluster</code>.</p> </li> </ul>"""
    target_db_instance_identifier: NotRequired["capo_docdb.types.string.String"]
    """<p>The name of the instance to promote to the primary instance.</p> <p>You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, <code>mydbcluster-replica1</code>.</p>"""

db_cluster_identifier instance-attribute 

db_cluster_identifier: NotRequired[String]

A cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

target_db_instance_identifier instance-attribute 

target_db_instance_identifier: NotRequired[String]

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.