describe_global_clusters

DocDB.Client.describe_global_clusters(**kwargs)

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

Note

This action only applies to Amazon DocumentDB 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 cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.
• Filters (list) --

  A filter that specifies one or more global DB clusters to describe.

  Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

  • (dict) --

    A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

    Wildcards are not supported in filters.

    • 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.
• 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
                },
            ]
        },
    ]
}

Response Structure

• (dict) --

  • Marker (string) --

  • GlobalClusters (list) --

    • (dict) --

      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 AWS CloudTrail log entries whenever the AWS 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.

        • (dict) --

          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.

Exceptions

• DocDB.Client.exceptions.GlobalClusterNotFoundFault