Skip to content

FailoverState

Source code in docs_src/capo_docdb/types/failover_state.py 
15
16
17
18
19
20
21
22
23
class FailoverState(TypedDict, closed=True):
    status: NotRequired["capo_docdb.types.failover_status.FailoverStatus"]
    """<p>The current status of the global cluster. Possible values are as follows:</p> <ul> <li> <p> <b>pending</b> – The service received a request to switch over or fail over the global cluster. The global cluster's primary cluster and the specified secondary cluster are being verified before the operation starts.</p> </li> <li> <p> <b>failing-over</b> – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.</p> </li> <li> <p> <b>cancelling</b> – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.</p> </li> </ul>"""
    from_db_cluster_arn: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.</p>"""
    to_db_cluster_arn: NotRequired["capo_docdb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being promoted, and which is associated with this state.</p>"""
    is_data_loss_allowed: NotRequired["capo_docdb.types.boolean.Boolean"]
    """<p>Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.</p>"""

from_db_cluster_arn instance-attribute 

from_db_cluster_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being demoted, and which is associated with this state.

is_data_loss_allowed instance-attribute 

is_data_loss_allowed: NotRequired[Boolean]

Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover.

status instance-attribute 

status: NotRequired[FailoverStatus]

The current status of the global cluster. Possible values are as follows:

  • pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary cluster and the specified secondary cluster are being verified before the operation starts.

  • failing-over – The chosen secondary cluster is being promoted to become the new primary cluster to fail over the global cluster.

  • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary cluster and the selected secondary cluster are returning to their previous states.

to_db_cluster_arn instance-attribute 

to_db_cluster_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the Amazon DocumentDB cluster that is currently being promoted, and which is associated with this state.