RDS / Client / describe_global_clusters

describe_global_clusters#

RDS.Client.describe_global_clusters(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_global_clusters(
    GlobalClusterIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • GlobalClusterIdentifier (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) –

    A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive.

    Currently, the only supported filter is region.

    If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions.

    • (dict) –

      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

      • DescribeDBRecommendations

      • DescribeDBShardGroups

      • DescribePendingMaintenanceActions

      • Name (string) – [REQUIRED]

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

      • Values (list) – [REQUIRED]

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

        • (string) –

  • MaxRecords (integer) –

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

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

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'GlobalClusters': [
        {
            'GlobalClusterIdentifier': 'string',
            'GlobalClusterResourceId': 'string',
            'GlobalClusterArn': 'string',
            'Status': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'DatabaseName': 'string',
            'StorageEncrypted': True|False,
            'DeletionProtection': True|False,
            'GlobalClusterMembers': [
                {
                    'DBClusterArn': 'string',
                    'Readers': [
                        'string',
                    ],
                    'IsWriter': True|False,
                    'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
                    'SynchronizationStatus': 'connected'|'pending-resync'
                },
            ],
            'FailoverState': {
                'Status': 'pending'|'failing-over'|'cancelling',
                'FromDbClusterArn': 'string',
                'ToDbClusterArn': 'string',
                'IsDataLossAllowed': True|False
            }
        },
    ]
}

Response Structure

  • (dict) –

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

      • (dict) –

        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 primary and secondary clusters within the global database cluster.

          • (dict) –

            A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database).

            • DBClusterArn (string) –

              The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster.

            • Readers (list) –

              The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster.

              • (string) –

            • IsWriter (boolean) –

              Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated.

            • GlobalWriteForwardingStatus (string) –

              The status of write forwarding for a secondary cluster in the global cluster.

            • SynchronizationStatus (string) –

              The status of synchronization of each Aurora DB cluster in the global cluster.

        • FailoverState (dict) –

          A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the SwitchoverGlobalCluster or FailoverGlobalCluster operation was called on this global cluster.

          • Status (string) –

            The current status of the global cluster. Possible values are as follows:

            • pending – The service received a request to switch over or fail over the global cluster. The global cluster’s primary DB cluster and the specified secondary DB cluster are being verified before the operation starts.

            • failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster.

            • cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states.

            • switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas.

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

          • IsDataLossAllowed (boolean) –

            Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it’s a switchover.

Exceptions