AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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.
See also: AWS API Documentation
failover-global-cluster
--global-cluster-identifier <value>
--target-db-cluster-identifier <value>
[--allow-data-loss | --no-allow-data-loss]
[--switchover | --no-switchover]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--global-cluster-identifier
(string)
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-:._]*
--target-db-cluster-identifier
(string)
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-:._]*
--allow-data-loss
| --no-allow-data-loss
(boolean)
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.
--switchover
| --no-switchover
(boolean)
Specifies whether to switch over this global database cluster.
Constraints:
- Can't be specified together with the
AllowDataLoss
parameter.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
GlobalCluster -> (structure)
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier -> (string)
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.GlobalClusterResourceId -> (string)
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in CloudTrail log entries whenever the KMS customer master key (CMK) for the cluster is accessed.GlobalClusterArn -> (string)
The Amazon Resource Name (ARN) for the global cluster.Status -> (string)
Specifies the current state of this global cluster.Engine -> (string)
The Amazon DocumentDB database engine used by the global cluster.EngineVersion -> (string)
Indicates the database engine version.DatabaseName -> (string)
The default database name within the new global cluster.StorageEncrypted -> (boolean)
The storage encryption setting for the global cluster.DeletionProtection -> (boolean)
The deletion protection setting for the new global cluster.GlobalClusterMembers -> (list)
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(structure)
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn -> (string)
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.Readers -> (list)
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.
(string)
IsWriter -> (boolean)
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.