SwitchoverGlobalClusterCommand

Suggest an Edit

Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DocDBClient, SwitchoverGlobalClusterCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, SwitchoverGlobalClusterCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // SwitchoverGlobalClusterMessage
  GlobalClusterIdentifier: "STRING_VALUE", // required
  TargetDbClusterIdentifier: "STRING_VALUE", // required
};
const command = new SwitchoverGlobalClusterCommand(input);
const response = await client.send(command);
// { // SwitchoverGlobalClusterResult
//   GlobalCluster: { // GlobalCluster
//     GlobalClusterIdentifier: "STRING_VALUE",
//     GlobalClusterResourceId: "STRING_VALUE",
//     GlobalClusterArn: "STRING_VALUE",
//     Status: "STRING_VALUE",
//     Engine: "STRING_VALUE",
//     EngineVersion: "STRING_VALUE",
//     DatabaseName: "STRING_VALUE",
//     StorageEncrypted: true || false,
//     DeletionProtection: true || false,
//     GlobalClusterMembers: [ // GlobalClusterMemberList
//       { // GlobalClusterMember
//         DBClusterArn: "STRING_VALUE",
//         Readers: [ // ReadersArnList
//           "STRING_VALUE",
//         ],
//         IsWriter: true || false,
//       },
//     ],
//   },
// };

SwitchoverGlobalClusterCommand Input

See SwitchoverGlobalClusterCommandInput for more details

Parameter
Type
Description
GlobalClusterIdentifier
Required
string | undefined

The identifier of the Amazon DocumentDB global database cluster to switch over. 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. This parameter isn’t case-sensitive.

Constraints:

  • Must match the identifier of an existing global cluster (Amazon DocumentDB global database).

  • Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

TargetDbClusterIdentifier
Required
string | undefined

The identifier of the secondary Amazon DocumentDB cluster to promote to the new primary for the global database 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-:._]*

SwitchoverGlobalClusterCommand Output

See SwitchoverGlobalClusterCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
GlobalCluster
GlobalCluster | undefined

A data type representing an Amazon DocumentDB global cluster.

Throws

Name
Fault
Details
DBClusterNotFoundFault
client

DBClusterIdentifier doesn't refer to an existing cluster.

GlobalClusterNotFoundFault
client

The GlobalClusterIdentifier doesn't refer to an existing global cluster.

InvalidDBClusterStateFault
client

The cluster isn't in a valid state.

InvalidGlobalClusterStateFault
client

The requested operation can't be performed while the cluster is in this state.

DocDBServiceException
Base exception class for all service exceptions from DocDB service.