FailoverGlobalClusterRequest Class

Container for the parameters to the FailoverGlobalCluster operation. Promotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs.

Use this operation to respond to an unplanned event, such as a regional disaster in the primary region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DocDB.AmazonDocDBRequest
      Amazon.DocDB.Model.FailoverGlobalClusterRequest

Namespace: Amazon.DocDB.Model
Assembly: AWSSDK.DocDB.dll
Version: 3.x.y.z

Syntax

public class FailoverGlobalClusterRequest : AmazonDocDBRequest
         IAmazonWebServiceRequest

The FailoverGlobalClusterRequest type exposes the following members

Constructors

	Name	Description
	FailoverGlobalClusterRequest()

Properties

Name	Type	Description
AllowDataLoss	System.Boolean	Gets and sets the property AllowDataLoss. Specifies whether to allow data loss for this global cluster operation. Allowing data loss triggers a global failover operation. If you don't specify `AllowDataLoss`, the global cluster operation defaults to a switchover. Constraints: Can't be specified together with the `Switchover` parameter.
GlobalClusterIdentifier	System.String	Gets and sets the property GlobalClusterIdentifier. The identifier of the Amazon DocumentDB global cluster to apply this operation. The identifier is the unique key assigned by the user when the cluster is created. In other words, it's the name of the global cluster. Constraints: Must match the identifier of an existing global cluster. Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
Switchover	System.Boolean	Gets and sets the property Switchover. Specifies whether to switch over this global database cluster. Constraints: Can't be specified together with the `AllowDataLoss` parameter.
TargetDbClusterIdentifier	System.String	Gets and sets the property TargetDbClusterIdentifier. The identifier of the secondary Amazon DocumentDB cluster that you want to promote to the primary for the global cluster. Use the Amazon Resource Name (ARN) for the identifier so that Amazon DocumentDB can locate the cluster in its Amazon Web Services region. Constraints: Must match the identifier of an existing secondary cluster. Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*`

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5