

# Usar a AWS CLI
<a name="single-region-aws-cli"></a>

A AWS CLI oferece uma interface de linha de comandos para gerenciar clusters do Aurora DSQL. Os exemplos a seguir demonstram operações comuns de gerenciamento de cluster.

## Criar cluster
<a name="create-cluster"></a>

Crie um cluster usando a o comando **create-cluster**.

**nota**  
A criação de clusters é uma operação assíncrona. Chame a API **GetCluster** até que o status mude para `ACTIVE`. Você pode se conectar ao cluster depois que ele ficar ativo.

**Example Command**  

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

**nota**  
Para desabilitar a proteção contra exclusão durante a criação, inclua o sinalizador `--no-deletion-protection-enabled`.

**Example Resposta**  

```
{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "CREATING",
    "creationTime": "2024-05-25T16:56:49.784000-07:00",
    "deletionProtectionEnabled": true,
    "tag": {},
    "encryptionDetails": {
        "encryptionType": "AWS_OWNED_KMS_KEY",
        "encryptionStatus": "ENABLED"
    }
}
```

## Descrever um cluster
<a name="get-cluster"></a>

Obtenha informações sobre um cluster usando o comando **get-cluster**.

**Example Command**  

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

**Example Resposta**  

```
{
    "identifier": "abc0def1baz2quux3quuux4",
    "arn": "arn:aws:dsql:us-east-1:111122223333:cluster/abc0def1baz2quux3quuux4",
    "status": "ACTIVE",
    "creationTime": "2024-11-27T00:32:14.434000-08:00",
    "deletionProtectionEnabled": false,
    "encryptionDetails": {
        "encryptionType": "CUSTOMER_MANAGED_KMS_KEY",
        "kmsKeyArn": "arn:aws:kms:us-east-1:111122223333:key/123a456b-c789-01de-2f34-g5hi6j7k8lm9",
        "encryptionStatus": "ENABLED"
    }
}
```

## Atualizar um cluster
<a name="update-cluster"></a>

Atualize um cluster existente usando o comando **update-cluster**.

**nota**  
As atualizações são operações assíncronas. Chame a API **GetCluster** até que o status mude para `ACTIVE` a fim de ver suas alterações.

**Example Command**  

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

**Example Resposta**  

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

## Excluir um cluster
<a name="delete-cluster"></a>

Exclua um cluster existente usando o comando **delete-cluster**.

**nota**  
É possível excluir somente clusters que tenham a proteção contra exclusão desabilitada. Por padrão, a proteção contra exclusão está habilitada ao criar clusters.

**Example Command**  

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

**Example Resposta**  

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

## Como listar clusters
<a name="list-clusters"></a>

Liste seus clusters usando o comando **list-clusters**.

**Example Command**  

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

**Example Resposta**  

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