AuroraDSQL / Client / get_cluster

get_cluster

AuroraDSQL.Client.get_cluster(**kwargs)

Retrieves information about a cluster.

See also: AWS API Documentation

Request Syntax

response = client.get_cluster(
    identifier='string'
)
Parameters:

identifier (string) –

[REQUIRED]

The ID of the cluster to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'identifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'IDLE'|'INACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED'|'PENDING_SETUP'|'PENDING_DELETE',
    'creationTime': datetime(2015, 1, 1),
    'deletionProtectionEnabled': True|False,
    'multiRegionProperties': {
        'witnessRegion': 'string',
        'clusters': [
            'string',
        ]
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    The output of a cluster.

    • identifier (string) –

      The ID of the retrieved cluster.

    • arn (string) –

      The ARN of the retrieved cluster.

    • status (string) –

      The status of the retrieved cluster.

    • creationTime (datetime) –

      The time of when the cluster was created.

    • deletionProtectionEnabled (boolean) –

      Whether deletion protection is enabled in this cluster.

    • multiRegionProperties (dict) –

      Returns the current multi-Region cluster configuration, including witness region and linked cluster information.

      • witnessRegion (string) –

        The that serves as the witness region for a multi-Region cluster. The witness region helps maintain cluster consistency and quorum.

      • clusters (list) –

        The set of linked clusters that form the multi-Region cluster configuration. Each linked cluster represents a database instance in a different Region.

        • (string) –

          The Amazon Resource Name of the cluster.

    • tags (dict) –

      Map of tags.

      • (string) –

        Unique tag key, maximum 128 Unicode characters in UTF-8.

        • (string) –

          Tag value, maximum 256 Unicode characters in UTF-8.

Exceptions