

# Habilitar a API de dados do Amazon RDS
<a name="data-api.enabling"></a>

Para usar a API de dados do Amazon RDS (API de dados), habilite-a para o cluster de banco de dados do Aurora. É possível habilitar a API de dados ao criar ou modificar o cluster de banco de dados.

**nota**  
 A disponibilidade da API de dados para o cluster depende da versão do Aurora, do mecanismo de banco de dados e da região da AWS. Em versões mais antigas do Aurora, a API de dados só funciona com clusters do Aurora Serverless v1. Em versões mais recentes do Aurora, a API de dados funciona com clusters que usam tanto instâncias provisionadas quanto do Aurora Serverless v2. Verifique se o cluster pode usar a API de dados em [Regiões e mecanismos de banco de dados do Aurora compatíveis com a API de dados do RDS](Concepts.Aurora_Fea_Regions_DB-eng.Feature.Data_API.md). 

**Topics**
+ [Habilitar a API de dados do RDS ao criar um banco de dados](#data-api.enabling.creating)
+ [Habilitar a API Data do RDS em um banco de dados existente](#data-api.enabling.modifying)

## Habilitar a API de dados do RDS ao criar um banco de dados
<a name="data-api.enabling.creating"></a>

Ao criar um banco de dados compatível com a API de dados do RDS (API de dados), é possível habilitar esse recurso. Os procedimentos a seguir descrevem como fazer isso ao usar o Console de gerenciamento da AWS, a AWS CLI ou a API do RDS.

### Console
<a name="data-api.enabling.creating.console"></a>

Para habilitar a API de dados ao criar um cluster de banco de dados, marque a caixa de seleção **Habilitar a API de dados do RDS** na seção **Conectividade** da página **Criar banco de dados**, como no screenshot a seguir.

![\[A seção Conectividade na página Criar banco de dados, com a caixa de seleção Habilitar a API de dados do RDS marcada.\]](http://docs.aws.amazon.com/pt_br/AmazonRDS/latest/AuroraUserGuide/images/data-api-enable-on-create.png)


Para ter instruções sobre como criar um cluster de banco de dados do Aurora que possa usar a API de dados do RDS, consulte o seguinte:
+ Para clusters do Aurora Serverless v2 e provisionados: [Criar um cluster de bancos de dados do Amazon Aurora](Aurora.CreateInstance.md)
+ Para Aurora Serverless v1: [Criar um cluster de banco de dados do Aurora Serverless v1](aurora-serverless.create.md)

### AWS CLI
<a name="data-api.enabling.creating.cli"></a>

Para habilitar a API de dados ao criar um cluster de banco de dados do Aurora, execute o comando [AWS CLIcreate-db-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-cluster.html) com a opção `--enable-http-endpoint`.

O exemplo a seguir cria um cluster de banco de dados do Aurora PostgreSQL com a API de dados habilitada.

Para Linux, macOS ou Unix:

```
aws rds create-db-cluster \
    --db-cluster-identifier my_pg_cluster \
    --engine aurora-postgresql \
    --enable-http-endpoint
```

Para Windows:

```
aws rds create-db-cluster ^
    --db-cluster-identifier my_pg_cluster ^
    --engine aurora-postgresql ^
    --enable-http-endpoint
```

### API do RDS
<a name="data-api.enabling.creating.api"></a>

Para habilitar a API de dados ao criar um cluster de banco de dados do Aurora, use a operação [CreatedBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html) com o valor do parâmetro `EnableHttpEndpoint` definido como `true`.

## Habilitar a API Data do RDS em um banco de dados existente
<a name="data-api.enabling.modifying"></a>

É possível modificar um cluster de banco de dados compatível com a API de dados do RDS (API de dados) para habilitar ou desabilitar esse recurso.

**Topics**
+ [Habilitar ou desabilitar a API de dados (Aurora Serverless v2 e provisionado)](#data-api.enabling.modifying.all)
+ [Habilitar ou desabilitar a API de dados (somente o Aurora Serverless v1)](#data-api.enabling.modifying.sv1)

### Habilitar ou desabilitar a API de dados (Aurora Serverless v2 e provisionado)
<a name="data-api.enabling.modifying.all"></a>

Use os procedimentos a seguir para habilitar ou desabilitar a API de dados em bancos de dados do Aurora Serverless v2 e provisionados. Para habilitar ou desabilitar a API de dados em bancos de dados do Aurora Serverless v1, use os procedimentos em [Habilitar ou desabilitar a API de dados (somente o Aurora Serverless v1)](#data-api.enabling.modifying.sv1).

#### Console
<a name="data-api.enabling.modifying.all.console"></a>

É possível habilitar ou desabilitar a API de dados usando o console do RDS para um cluster de banco de dados que seja compatível com esse recurso. Para fazer isso, abra a página de detalhes do cluster do banco de dados no qual você deseja habilitar ou desabilitar a API de dados e, na guia **Conectividade e segurança**, vá para a seção **API de dados do RDS**. Esta seção exibe o status da API de dados e permite habilitá-la ou desabilitá-la.

O screenshot a seguir mostra que a **API de dados do RDS** não está habilitada.

![\[A seção API de dados do RDS na guia Conectividade e segurança da página de detalhes de um cluster de banco de dados. O status da API de dados é exibido como desabilitado e o botão Habilitar API de dados do RDS está presente.\]](http://docs.aws.amazon.com/pt_br/AmazonRDS/latest/AuroraUserGuide/images/data-api-enable-from-details.png)


#### AWS CLI
<a name="data-api.enabling.modifying.all.cli"></a>

Para habilitar ou desabilitar a API de dados em um banco de dados existente, execute o comando [enable-http-endpoint](https://docs.aws.amazon.com/cli/latest/reference/rds/enable-http-endpoint.html) ou [disable-http-endpoint](https://docs.aws.amazon.com/cli/latest/reference/rds/disable-http-endpoint.html) da AWS CLI e especifique o ARN do cluster de banco de dados.

O exemplo a seguir habilita a API de dados.

Para Linux, macOS ou Unix:

```
aws rds enable-http-endpoint \
    --resource-arn cluster_arn
```

Para Windows:

```
aws rds enable-http-endpoint ^
    --resource-arn cluster_arn
```

#### API do RDS
<a name="data-api.enabling.modifying.all.api"></a>

Para habilitar ou desabilitar a API de dados em um banco de dados existente, use as operações [EnableHttpEndpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_EnableHttpEndpoint.html) e [DisableHttpEndpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DisableHttpEndpoint.html).

### Habilitar ou desabilitar a API de dados (somente o Aurora Serverless v1)
<a name="data-api.enabling.modifying.sv1"></a>

Use os procedimentos a seguir para habilitar ou desabilitar a API de dados em bancos de dados do Aurora Serverless v1. Para habilitar ou desabilitar a API de dados em bancos de dados do Aurora Serverless v2 e provisionados, use os procedimentos em [Habilitar ou desabilitar a API de dados (Aurora Serverless v2 e provisionado)](#data-api.enabling.modifying.all).

#### Console
<a name="data-api.enabling.modifying.sv1.console"></a>

Ao modificar um cluster de banco de dados do Aurora Serverless v1, habilite a API de dados na seção **Conectividade** do console do RDS.

O screenshot a seguir mostra a **API de dados** habilitada ao modificar um cluster de banco de dados do Aurora.

![\[Na seção Conectividade na página Modificar cluster de banco de dados, a caixa de seleção API de dados está marcada.\]](http://docs.aws.amazon.com/pt_br/AmazonRDS/latest/AuroraUserGuide/images/data-api-modify-serverlessv1.png)


Para ter instruções sobre como modificar um cluster de banco de dados do Aurora Serverless v1, consulte [Modificar um cluster de banco de dados do Aurora Serverless v1](aurora-serverless.modifying.md).

#### AWS CLI
<a name="data-api.enabling.modifying.sv1.cli"></a>

Para habilitar ou desativar a API de dados, execute o comando [modify-db-cluster](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-cluster.html) da AWS CLI com o `--enable-http-endpoint` ou o `--no-enable-http-endpoint`, conforme aplicável.

O exemplo a seguir habilita a API de dados no `sample-cluster`.

Para Linux, macOS ou Unix:

```
aws rds modify-db-cluster \
    --db-cluster-identifier sample-cluster \
    --enable-http-endpoint
```

Para Windows:

```
aws rds modify-db-cluster ^
    --db-cluster-identifier sample-cluster ^
    --enable-http-endpoint
```

#### API do RDS
<a name="data-api.enabling.modifying.sv1.api"></a>

Para habilitar a API de dados, use a operação [ModifyDBCluster](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) e defina o valor de `EnableHttpEndpoint` como `true` ou `false`, conforme aplicável.