AuroraDSQL / Client / create_cluster

create_cluster#

AuroraDSQL.Client.create_cluster(**kwargs)#

Creates a cluster in Amazon Aurora DSQL.

See also: AWS API Documentation

Request Syntax

response = client.create_cluster(
    deletionProtectionEnabled=True|False,
    tags={
        'string': 'string'
    },
    clientToken='string'
)
Parameters:

  • deletionProtectionEnabled (boolean) – If enabled, you can’t delete your cluster. You must first disable this property before you can delete your cluster.

  • tags (dict) –

    A map of key and value pairs to use to tag your cluster.

    • (string) –

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

      • (string) –

        Tag value, maximum 256 Unicode characters in UTF-8

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

Response Structure

  • (dict) –

    Output Mixin

    • identifier (string) –

      The ID of the created cluster.

    • arn (string) –

      The ARN of the created cluster.

    • status (string) –

      The status of the created cluster.

    • creationTime (datetime) –

      The time of when created the cluster.

    • deletionProtectionEnabled (boolean) –

      Whether deletion protection is enabled on this cluster.

Exceptions