Aurora DSQL com a AWS CLI - Amazon Aurora DSQL
CreateClusterGetClusterUpdateClusterDeleteClusterListClustersGetCluster em clusters mutirregionais

Aurora DSQL com a AWS CLI

Consulte as seções a seguir para aprender a gerenciar clusters com a AWS CLI.

CreateCluster

Para criar um cluster, use o comando create-cluster.

nota

A criação de clusters ocorre de forma assíncrona. Chame a API GetCluster até que o status seja ACTIVE. Você pode se conectar a um cluster assim que ele ficar ACTIVE.

Exemplo de comando

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

Se você quiser desabilitar a proteção contra exclusão na criação, inclua o sinalizador --no-deletion-protection-enabled.

Exemplo de resposta

{
    "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

Para descrever um cluster, use o comando get-cluster.

Exemplo de comando

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

Exemplo de resposta

{
    "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

Para atualizar um cluster existente, use o comando update-cluster.

nota

As atualizações ocorrem de forma assíncrona. Chame a API GetCluster até que o status seja ACTIVE, e você observará as alterações.

Exemplo de comando

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

Exemplo de resposta

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

DeleteCluster

Para excluir um cluster existente, use o comando delete-cluster.

nota

Você pode excluir somente um cluster que tenha a proteção contra exclusão desabilitada. A proteção contra exclusão está habilitada por padrão ao criar clusters.

Exemplo de comando

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

Exemplo de resposta

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

ListClusters

Para obter uma lista de clusters, use o comando list-clusters.

Exemplo de comando

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

Exemplo de resposta

{
    "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 em clusters mutirregionais

Para ter informações sobre um cluster multirregional, use o comando get-cluster. Para clusters multirregionais, a resposta incluirá o ARN dos clusters vinculados.

Exemplo de comando

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

Exemplo de resposta

{
    "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"
    }
}