Habilitar a API de dados do Amazon RDS - Amazon Aurora
Habilitar a API de dados do RDS ao criar um banco de dadosHabilitar a API Data do RDS em um banco de dados existente

Habilitar a API de dados do Amazon RDS

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.

Habilitar a API de dados do RDS ao criar um banco de dados

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 AWS Management Console, a AWS CLI ou a API do RDS.

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.

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 habilitar a API de dados ao criar um cluster de banco de dados do Aurora, execute o comando AWS CLIcreate-db-cluster 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

Para habilitar a API de dados ao criar um cluster de banco de dados do Aurora, use a operação CreatedBCluster com o valor do parâmetro EnableHttpEndpoint definido como true.

Habilitar a API Data do RDS em um banco de dados existente

É 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.

Habilitar ou desabilitar a API de dados (Aurora Serverless v2 e provisionado)

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).

É 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.

Para habilitar ou desabilitar a API de dados em um banco de dados existente, execute o comando enable-http-endpoint ou disable-http-endpoint 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

Para habilitar ou desabilitar a API de dados em um banco de dados existente, use as operações EnableHttpEndpoint e DisableHttpEndpoint.

Habilitar ou desabilitar a API de dados (somente o Aurora Serverless v1)

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).

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.

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.

Para habilitar ou desativar a API de dados, execute o comando modify-db-cluster 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

Para habilitar a API de dados, use a operação ModifyDBCluster e defina o valor de EnableHttpEndpoint como true ou false, conforme aplicável.