Habilitación de la API de datos de Amazon RDS - Amazon Aurora

Habilitación de la API de datos de Amazon RDS

Para utilizar la API de datos de Amazon RDS (API de datos), habilítela para el clúster de base de datos de Aurora. Puede habilitar la API de datos cuando cree o modifique el clúster de base de datos.

nota

La disponibilidad de la API de datos para el clúster depende de la versión de Aurora, del motor de base de datos y de la región de AWS. En las versiones anteriores de Aurora, la API de datos solo funciona con los clústeres de Aurora Serverless v1. En las versiones más recientes de Aurora, la API de datos funciona con clústeres que utilizan tanto instancias de Aurora Serverless v2 como aprovisionadas. Para comprobar si el clúster puede utilizar la API de datos, consulte Regiones y motores de base de datos Aurora admitidos para API de datos de RDS.

Habilitación de la API de datos de RDS al crear una base de datos

Al crear una base de datos compatible con la API de datos de RDS (API de datos), puede habilitar esta característica. Los siguientes procedimientos describen el proceso al utilizar la AWS Management Console, la AWS CLI o la API de RDS.

Para habilitar la API de datos al crear un clúster de base de datos, seleccione la casilla Habilitar la API de datos de RDS en la sección Conectividad de la página Crear base de datos, como se muestra en la siguiente captura de pantalla.

La sección Conectividad de la página Crear base de datos, con la casilla Habilitar la API de datos de RDS seleccionada.

Para obtener instrucciones sobre cómo crear un clúster de base de datos de Aurora que pueda usar la API de datos de RDS, consulte lo siguiente:

Para habilitar la API de datos mientras crea un clúster de base de datos de Aurora, ejecute el comando de la AWS CLI create-db-clúster con la opción --enable-http-endpoint.

En el ejemplo siguiente se crea un clúster de base de datos de Aurora PostgreSQL con la API de datos habilitada.

Para Linux, macOS o 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 la API de datos al crear un clúster de base de datos de Aurora, utilice la operación CreateDBclúster con el valor del parámetro EnableHttpEndpoint establecido en true.

Habilitación de la API de datos de RDS en una base de datos existente

Puede modificar un clúster de base de datos que admita la API de datos de RDS (API de datos) para activar o desactivar esta característica.

Habilitación o deshabilitación de la API de datos (Aurora Serverless v2 y aprovisionada)

Utilice los siguientes procedimientos para habilitar o deshabilitar la API de datos en las bases de datos de Aurora Serverless v2 y aprovisionadas. Para activar o desactivar la API de datos en las bases de datos de Aurora Serverless v1, utilice los procedimientos descritos en Habilitación o deshabilitación de la API de datos (solo Aurora Serverless v1).

Puede habilitar o deshabilitar la API de datos con la consola de RDS para un clúster de base de datos que sea compatible con esta característica. Para ello, abra la página de detalles del clúster de la base de datos en la que desee habilitar o deshabilitar la API de datos y, en la pestaña Conectividad y seguridad, vaya a la sección API de datos de RDS. Esta sección muestra el estado de la API de datos y le permite habilitarla o deshabilitarla.

La siguiente captura de pantalla muestra que la API de datos de RDS no está habilitada.

La sección API de datos de RDS en la pestaña Conectividad y seguridad de la página de detalles de un clúster de base de datos. El estado de la API de datos aparece como deshabilitado y aparece el botón Habilitar la API de datos de RDS.

Para habilitar o deshabilitar la API de datos en una base de datos existente, ejecute el comando de la AWS CLI enable-http-endpoint o disable-http-endpoint y especifique el ARN de su clúster de base de datos.

En el ejemplo siguiente se habilita la API de datos.

Para Linux, macOS o Unix:

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

Para Windows:

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

Para habilitar o deshabilitar la API de datos en una base de datos existente, utilice las operaciones EnableHttpEndpoint y DisableHttpEndpoint.

Habilitación o deshabilitación de la API de datos (solo Aurora Serverless v1)

Para habilitar o deshabilitar la API de datos en las bases de datos de Aurora Serverless v1 existentes. Para habilitar o deshabilitar la API de datos en las bases de datos de Aurora Serverless v2 y aprovisionadas, utilice los procedimientos indicados en Habilitación o deshabilitación de la API de datos (Aurora Serverless v2 y aprovisionada).

Cuando cree o modifique un clúster de base de datos de Aurora Serverless v1, debe habilitar la API de datos en la sección Conectividad de la consola de RDS.

En la siguiente captura de pantalla se muestra la API de datos cuando se modifica un clúster de base de datos de Aurora.

En la sección Conectividad de la página Modificar el clúster de base de datos, está seleccionada la casilla de verificación API de datos.

Para obtener instrucciones sobre cómo modificar un clúster de base de datos de Aurora Serverless v1, consulte Modificación de un clúster de bases de datos de Aurora Serverless v1.

Para habilitar o deshabilitar la API de datos, ejecute el comando de la AWS CLI modify-db-clúster con --enable-http-endpoint o --no-enable-http-endpoint, según corresponda.

En el ejemplo siguiente se habilita la API de datos en sample-cluster.

Para Linux, macOS o 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 la API de datos, utilice la operación ModifyDBclúster y establezca el valor de EnableHttpEndpoint en true o false, según corresponda.