Aurora DSQL with the AWS CLI - Amazon Aurora DSQL
CreateClusterGetClusterUpdateClusterDeleteClusterListClustersGetCluster on multi-Region clusters

Aurora DSQL with the AWS CLI

See the following sections to learn how to manage your clusters with the AWS CLI.

CreateCluster

To create a cluster, use the create-cluster command.

Note

Cluster creation happens asynchronously. Call the GetCluster API until the status is ACTIVE. You can connect to a cluster once it becomes ACTIVE.

Sample command

aws dsql create-cluster --region us-east-1
Note

If you want to disable deletion protection upon creation, include the --no-deletion-protection-enabled flag.

Sample response

{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "CREATING",
    "creationTime": "2025-05-22T14:03:26.631000-07:00",
    "encryptionDetails": {
        "encryptionType": "AWS_OWNED_KMS_KEY",
        "encryptionStatus": "ENABLED"
    },
    "deletionProtectionEnabled": true
}

GetCluster

To describe an cluster, use the get-cluster command.

Sample command

aws dsql get-cluster \
  --region us-east-1 \
  --identifier <your_cluster_id>

Sample response

{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "ACTIVE",
    "creationTime": "2025-05-22T14:03:26.631000-07:00",
    "deletionProtectionEnabled": true,
    "tags": {},
    "encryptionDetails": {
        "encryptionType": "AWS_OWNED_KMS_KEY",
        "encryptionStatus": "ENABLED"
    }
}

UpdateCluster

To update an existing cluster, use the update-cluster command.

Note

Updates happen asynchronously. Call the GetCluster API until the status is ACTIVE and you'll observe the changes.

Sample command

aws dsql update-cluster \
  --region us-east-1 \
  --no-deletion-protection-enabled \
  --identifier your_cluster_id

Sample response

{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "UPDATING",
    "creationTime": "2024-05-24T09:15:32.708000-07:00"
}

DeleteCluster

To delete an existing cluster, use the delete-cluster command.

Note

You can only delete a cluster which has deletion protection disabled. Deletion protection is enabled by default when creating new clusters.

Sample command

aws dsql delete-cluster \
  --region us-east-1 \
  --identifier your_cluster_id

Sample response

{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "DELETING",
    "creationTime": "2024-05-24T09:16:43.778000-07:00"
}

ListClusters

To get the a of clusters, use the list-clusters command.

Sample command

aws dsql list-clusters --region us-east-1

Sample response

{
    "clusters": [
        {
            "identifier": "abc0def1baz2quux3quux4quuux",
            "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quux4quuux"
        },
        {
            "identifier": "abc0def1baz2quux3quux4quuuux",
            "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quux4quuuux"
        }
    ]
}

GetCluster on multi-Region clusters

To get information about a multi-Region cluster, use the get-cluster command. For multi-Region clusters the response will include the linked cluster ARNs.

Sample command

aws dsql get-cluster \
  --region us-east-1 \
  --identifier your_cluster_id

Sample response

{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "ACTIVE",
    "creationTime": "2025-05-22T13:56:18.716000-07:00",
    "deletionProtectionEnabled": true,
    "multiRegionProperties": {
        "witnessRegion": "us-west-2",
        "clusters": [
            "arn:aws:dsql:us-east-1:842685632318:cluster/fuabuc7d3szkr37uqd5znkjynu"
        ]
    },
    "tags": {},
    "encryptionDetails": {
        "encryptionType": "AWS_OWNED_KMS_KEY",
        "encryptionStatus": "ENABLED"
    }
}