describe-global-clusters¶

Description¶

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .

Note

This action only applies to Aurora DB clusters.

Synopsis¶

  describe-global-clusters
[--global-cluster-identifier <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--global-cluster-identifier (string)

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn’t case-sensitive.

Constraints:

If supplied, must match an existing DBClusterIdentifier.

--filters (list)

This parameter isn’t currently supported.

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:

DescribeDBClusterBacktracks

DescribeDBClusterEndpoints

DescribeDBClusters

DescribeDBInstances

DescribePendingMaintenanceActions

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

One or more filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To describe global DB clusters

The following describe-global-clusters example lists Aurora global DB clusters in the current AWS Region.

aws rds describe-global-clusters

Output:

{
    "GlobalClusters": [
        {
            "GlobalClusterIdentifier": "myglobalcluster",
            "GlobalClusterResourceId": "cluster-f5982077e3b5aabb",
            "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
            "Status": "available",
            "Engine": "aurora-mysql",
            "EngineVersion": "5.7.mysql_aurora.2.07.2",
            "StorageEncrypted": false,
            "DeletionProtection": false,
            "GlobalClusterMembers": []
        }
    ]
}

For more information, see Managing an Aurora global database in the Amazon Aurora User Guide.

Output¶

Marker -> (string)

An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

GlobalClusters -> (list)

The list of global clusters returned by this request.

(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.

Table of Contents

Feedback

User Guide