AuroraDSQL / Client / update_cluster

update_cluster#

AuroraDSQL.Client.update_cluster(**kwargs)#

Updates a cluster.

See also: AWS API Documentation

Request Syntax

response = client.update_cluster(
    identifier='string',
    deletionProtectionEnabled=True|False,
    clientToken='string'
)
Parameters:

  • identifier (string) –

    [REQUIRED]

    The ID of the cluster you want to update.

  • deletionProtectionEnabled (boolean) – Specifies whether to enable deletion protection in your cluster.

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

    If you don’t specify a client token, the Amazon Web Services SDK automatically generates one.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'identifier': 'string',
    'arn': 'string',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'FAILED',
    'creationTime': datetime(2015, 1, 1),
    'deletionProtectionEnabled': True|False,
    'witnessRegion': 'string',
    'linkedClusterArns': [
        'string',
    ]
}

Response Structure

  • (dict) –

    Output Mixin

    • identifier (string) –

      The ID of the cluster to update.

    • arn (string) –

      The ARN of the updated cluster.

    • status (string) –

      The status of the updated cluster.

    • creationTime (datetime) –

      The time of when the cluster was created.

    • deletionProtectionEnabled (boolean) –

      Whether deletion protection is enabled for the updated cluster.

    • witnessRegion (string) –

      The Region that receives all data you write to linked clusters.

    • linkedClusterArns (list) –

      The ARNs of the clusters linked to the updated cluster. Applicable only for multi-Region clusters.

      • (string) –

        Cluster ARN

Exceptions

  • AuroraDSQL.Client.exceptions.ThrottlingException

  • AuroraDSQL.Client.exceptions.AccessDeniedException

  • AuroraDSQL.Client.exceptions.ValidationException

  • AuroraDSQL.Client.exceptions.InternalServerException

  • AuroraDSQL.Client.exceptions.ResourceNotFoundException

  • AuroraDSQL.Client.exceptions.ConflictException