Switchover Global Cluster

neptune_switchover_global_cluster

R Documentation

Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster¶

Description¶

Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster. Switchover operations were previously called "managed planned failovers."

Promotes the specified secondary cluster to assume full read/write capabilities and demotes the current primary cluster to a secondary (read-only) cluster, maintaining the original replication topology. All secondary clusters are synchronized with the primary at the beginning of the process so the new primary continues operations for the global database without losing any data. Your database is unavailable for a short time while the primary and selected secondary clusters are assuming their new roles.

This operation is intended for controlled environments, for operations such as "regional rotation" or to fall back to the original primary after a global database failover.

Usage¶

neptune_switchover_global_cluster(GlobalClusterIdentifier,
  TargetDbClusterIdentifier)

Arguments¶

GlobalClusterIdentifier

[required] The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.

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

TargetDbClusterIdentifier

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

Value¶

A list with the following syntax:

list(
  GlobalCluster = list(
    GlobalClusterIdentifier = "string",
    GlobalClusterResourceId = "string",
    GlobalClusterArn = "string",
    Status = "string",
    Engine = "string",
    EngineVersion = "string",
    DatabaseName = "string",
    StorageEncrypted = TRUE|FALSE,
    DeletionProtection = TRUE|FALSE,
    GlobalClusterMembers = list(
      list(
        DBClusterArn = "string",
        Readers = list(
          "string"
        ),
        IsWriter = TRUE|FALSE
      )
    ),
    FailoverState = list(
      Status = "pending"|"failing-over"|"cancelling",
      FromDbClusterArn = "string",
      ToDbClusterArn = "string",
      IsDataLossAllowed = TRUE|FALSE
    ),
    TagList = list(
      list(
        Key = "string",
        Value = "string"
      )
    )
  )
)

Request syntax¶

svc$switchover_global_cluster(
  GlobalClusterIdentifier = "string",
  TargetDbClusterIdentifier = "string"
)