failover-global-cluster¶
Description¶
Initiates the failover process for an Aurora global database ( GlobalCluster ).
A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.
For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide .
Note
This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.
See also: AWS API Documentation
Synopsis¶
failover-global-cluster
--global-cluster-identifier <value>
--target-db-cluster-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--global-cluster-identifier (string)
Identifier of the Aurora global database ( GlobalCluster ) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it’s the name of the Aurora global database that you want to fail over.
Constraints:
Must match the identifier of an existing GlobalCluster (Aurora global database).
--target-db-cluster-identifier (string)
Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database ( GlobalCluster .) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--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.
json
text
table
yaml
yaml-stream
--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.
on
off
auto
--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.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
GlobalCluster -> (structure)
A data type representing an Aurora global database.
GlobalClusterIdentifier -> (string)
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId -> (string)
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
GlobalClusterArn -> (string)
The Amazon Resource Name (ARN) for the global database cluster.
Status -> (string)
Specifies the current state of this global database cluster.
Engine -> (string)
The Aurora database engine used by the global database cluster.
EngineVersion -> (string)
Indicates the database engine version.
DatabaseName -> (string)
The default database name within the new global database cluster.
StorageEncrypted -> (boolean)
The storage encryption setting for the global database cluster.
DeletionProtection -> (boolean)
The deletion protection setting for the new global database cluster.
GlobalClusterMembers -> (list)
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(structure)
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn -> (string)
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers -> (list)
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
(string)
IsWriter -> (boolean)
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus -> (string)
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState -> (structure)
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status -> (string)
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
pending – A request to fail over the Aurora global database ( GlobalCluster ) has been received by the service. The
GlobalCluster‘s primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.failing-over – This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas.
cancelling – The request to fail over the Aurora global database ( GlobalCluster ) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.
FromDbClusterArn -> (string)
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn -> (string)
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.