Amazon S3

El conector de Amazon S3 proporciona acceso de SQL a los buckets y objetos de Amazon S3.

Antes de comenzar

Antes de usar el conector de Amazon S3, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Otorga el rol de IAM roles/connectors.admin al usuario que configura el conector.
    • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API de Secret Manager)
      • connectors.googleapis.com (API de conectores)

      Para comprender cómo habilitar servicios, consulta Habilita servicios.

    Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

  2. Haz clic en + Crear nuevo para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación para la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

      Entre las regiones admitidas para los conectores, se incluyen las siguientes:

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

    2. Haz clic en Siguiente.
  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Conector: Selecciona Amazon S3 en la lista desplegable de conectores disponibles.
    2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
    3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 63 caracteres.
    4. De manera opcional, ingresa una Descripción para la instancia de conexión.
    5. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    6. De manera opcional, configura los parámetros de nodo de conexión:

      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

    7. Región de AWS: Región en la que se aloja tu instancia de Amazon S3.
    8. De manera opcional, haz clic en + Agregar etiqueta (+ Add label) para agregar una etiqueta a la conexión en forma de par clave-valor.
    9. Haz clic en Siguiente.
  5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
    1. Tipo de destino: Selecciona un Tipo de destino.
      1. En el campo Dirección de host, especifica el nombre de host o la dirección IP del destino.
        1. Si deseas establecer una conexión privada a tus sistemas de backend, sigue estos pasos:
          1. Crea un adjunto de servicio de PSC.
          2. Crea un adjunto de extremo y, luego, ingresa los detalles del adjunto del extremo en el campo Dirección del host.
        2. Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes considerar configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir solo las direcciones IP estáticas específicas.

      Para ingresar destinos adicionales, haz clic en +Agregar destino.

    2. Haz clic en Siguiente.
  6. En la sección Autenticación, ingresa los detalles de autenticación.
    1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión de Amazon S3 admite los siguientes tipos de autenticación:

      • Credenciales raíz
      • Funciones de IAM de AWS
      • Credenciales temporales de AWS

      2. Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

    2. Haz clic en Siguiente.
  7. Revisa: Revisa tus detalles de conexión y autenticación.
  8. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

  • Credenciales raíz

    Para autenticar con las credenciales raíz de la cuenta

    • Clave de acceso de AWS: la clave de acceso del usuario raíz.
    • Secreto de acceso de AWS: Es la clave secreta del usuario raíz.
  • Funciones de IAM de AWS

    Para autenticar con un rol de IAM de AWS.

    • Clave de acceso de AWS: la clave de acceso del usuario de IAM para el que se asumirá el rol
    • Secreto de acceso de AWS: La clave secreta del usuario de IAM para el que se asumirá el rol
    • ARN de rol de AWS: Especifica el ARN de rol para la función con la que deseas autenticarte. Solo se recuperarían las credenciales del rol especificado.
    • ID externo de AWS: Es obligatorio solo cuando asumes un rol en otra cuenta.
  • Credenciales temporales de AWS

    Sigue estos pasos para autenticar con credenciales temporales:

    • Clave de acceso de AWS: la clave de acceso del usuario de IAM para el que se asumirá el rol
    • Secreto de acceso de AWS: La clave secreta del usuario de IAM para el que se asumirá el rol
    • Token de sesión de AWS: Se genera junto con las credenciales temporales.
    • ARN de rol de AWS: Especifica el ARN de rol para la función con la que deseas autenticarte. Solo se recuperarían las credenciales del rol especificado.
    • ID externo de AWS: Es obligatorio solo cuando asumes un rol en otra cuenta.

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

  • Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

    Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

  • Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

    Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, tales operaciones no compatibles no aparecerán en la lista Operations.

  • Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Acciones

En esta sección, se enumeran algunas de las acciones que admite el conector. Para comprender cómo configurar las acciones, consulta Ejemplos de acciones.

Action CopyObject

Esta acción te permite copiar un objeto de un bucket a otro o dentro del mismo bucket.

Parámetros de entrada de la acción CopyObject

Nombre del parámetro Tipo de datos Requeridos Descripción
BucketSource String Sí Nombre del bucket desde el que se debe copiar el objeto.
ObjectSource Objeto Sí El nombre del objeto que se debe copiar.
BucketDestination String Sí Nombre del bucket donde se debe copiar el objeto.
ObjectDestination String No Nombre del objeto en el bucket de destino. Si no se especifica, el nombre será igual que el original.

Parámetros de salida de la acción CopyObject

Esta acción devuelve el estado 200 (OK) si la copia es exitosa.

Para comprender cómo configurar la acción CopyObject, consulta Ejemplos de acciones.

Acción DownloadObjects

Con esta acción, se obtiene un objeto más de un bucket.

Parámetros de entrada de la acción DownloadObjects

Nombre del parámetro Tipo de datos Requeridos Descripción
Bucket String Sí Nombre del bucket en el que se encuentra el objeto que se descargará.
Objeto String No Nombre del objeto que se debe descargar. Si no se especifica, se descargarán todos los objetos del bucket especificado.
HasBytes Booleano Sí Especifica si se debe descargar el contenido como una cadena codificada en Base64.
UpdatedStartDate Fecha y hora No La fecha de inicio del período para descargar objetos. Si no se especifica, los objetos se descargan desde el más antiguo hasta laUpdatedEndDate.
UpdatedEndDate Fecha y hora No La fecha de finalización del período para descargar objetos. Si no se especifica, los objetos se descargan desde la fecha de actualización especificada hasta el día actual.

Parámetros de resultado de la acción DownloadObjects

Esta acción devuelve el estado 200 (OK) si la descarga es exitosa.

Para comprender cómo configurar la acción DownloadObjects, consulta Ejemplos de acciones.

Acción UploadObject

Esta acción te permite subir un objeto a un bucket.

Parámetros de entrada de la acción UploadObject

Nombre del parámetro Tipo de datos Requeridos Descripción
Bucket String Sí Nombre del bucket donde se debe subir el objeto.
ContentBytes String No Contenido de bytes que se subirá como un archivo.
HasBytes Booleano Sí Especifica si el contenido se debe subir como una cadena codificada en Base64.
AccessPolicy String No La política de acceso para este objeto. Los valores permitidos son PRIVATE, ANONREAD, ANONREADWRITE y AUTHREAD. El valor predeterminado es PRIVATE.
Temario String No El contenido que se subirá.
FileName String No Nombre del archivo que se subirá. Este valor es obligatorio cuando especificas el parámetro FileContent.

Parámetros de salida de la acción UploadObject

Esta acción devuelve el estado 200 (OK) si la carga del objeto es correcta.

Para comprender cómo configurar la acción UploadObject, consulta Ejemplos de acciones.

Acción DeleteObject

Esta acción te permite borrar un objeto de un bucket.

Parámetros de entrada de la acción DeleteObject

Nombre del parámetro Tipo de datos Requeridos Descripción
Bucket String Sí Nombre del bucket en el que se encuentra el objeto que se borrará.
Objeto String Sí Nombre del objeto que se debe borrar.

Parámetros de salida de la acción DeleteObject

Esta acción devuelve el estado 200 (OK) si la eliminación se realiza correctamente.

Para comprender cómo configurar la acción DeleteObject, consulta Ejemplos de acciones.

Action MoveObject

Esta acción les permite a los usuarios mover un objeto existente de un bucket específico a otro bucket o al mismo bucket.

Parámetros de entrada de la acción MoveObject

Nombre del parámetro Tipo de datos Requeridos Descripción
BucketSource String Sí El nombre del bucket de origen al que está presente el objeto que se moverá
ObjectSource String Sí Es el nombre del objeto que se debe mover.
BucketDestination String Sí El nombre del bucket de destino al que se debe mover el objeto.
ObjectDestination String No Nombre del objeto en el bucket de destino. Si no se especifica, se conserva el nombre original.

Parámetros de salida de la acción MoveObject

Esta acción devuelve el estado 200 (OK) si la operación de movimiento se realiza correctamente.

Para comprender cómo configurar la acción MoveObject, consulta Ejemplos de acciones.

Acción PutBucketAcl

Esta acción te permite actualizar la lista de control de acceso (LCA) de un bucket.

Parámetros de entrada de la acción PutBucketAcl

Nombre del parámetro Tipo de datos Requeridos Descripción
Bucket String Sí Nombre del bucket para el que se debe aplicar la LCA.
ACL String Sí Nivel de acceso que se aplicará al bucket.

Parámetros de salida de la acción PutBucketAcl

Esta acción devuelve el estado 200 (OK) si la actualización de la LCA del bucket es correcta.

Para comprender cómo configurar la acción PutBucketAcl, consulta Ejemplos de acciones.

Acción PutObjectAcl

Esta acción te permite actualizar la lista de control de acceso (LCA) de un objeto en un bucket.

Parámetros de entrada de la acción PutObjectAcl

Nombre del parámetro Tipo de datos Requeridos Descripción
Bucket String Sí Nombre del bucket en el que está presente el objeto.
ACL String Sí El nivel de acceso que se aplicará al objeto.
KEY String Sí Nombre del objeto para el que se debe aplicar la LCA.

Parámetros de salida de la acción PutObjectAcl

Esta acción devuelve el estado 200 (OK) si la actualización de la LCA del objeto es correcta.

Para comprender cómo configurar la acción PutObjectAcl, consulta Ejemplos de acciones.

Ejemplos de acciones

En esta sección, se describe cómo realizar algunas de las acciones en este conector.

Ejemplo: copia un objeto

En este ejemplo, se copia un objeto de un bucket a otro.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CopyObject y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"BucketSource": "aws-s3-bucket-source",
"ObjectSource": "pic.jpg",
"BucketDestination": "aws-s3-bucket-destination",
"ObjectDestination": "new_pic.jpg"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea CopyObject tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Descarga un objeto

En este ejemplo, se descarga un objeto del bucket especificado.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadObjects y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Bucket": "aws-s3-bucket-source",
"HasBytes": true
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea DownloadObjects tendrá un valor similar al siguiente:

    [{
"Success": "True",
"RemoteFile": "prefix1%2Faws-s3-bucket-source%2Finventory-test-1%2F2023-09-10T01-00Z%2Fmanifest.json",
"ContentBytes": "ewogICJzb3VyY2VCdWNrZXQiIDogImF3cy1zMy1idWNrZXQtYmNvbmUiLAogICJnOK"
},
{
"Success": "True",
"RemoteFile": "upload1.txt",
"ContentBytes": "VGhpcyBpcyBhIHRlc3RpbmcgZmlsZQ=="
}]

Ejemplo: sube un objeto

En este ejemplo, se sube un objeto al bucket especificado.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción UploadObject y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Bucket": "aws-s3-bucket-source",
"FileName": "upload_1.txt",
"Content": "This is a testing file",
"AccessPolicy": "PUBLIC"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea UploadObject tendrá un valor similar al siguiente:

    [{
"Status": "success",
"bucket": "aws-s3-bucket-source",
"rss:title": "Object 'upload_1.txt' was created in the bucket: aws-s3-bucket-source",
"object": "upload_1.txt"
}]

Ejemplo: Borra un objeto

En este ejemplo, se borra un objeto del bucket especificado.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DeleteObject y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Bucket": "aws-s3-bucket-source",
"Object": "abc.png"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea DeleteObject tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: Mueve un objeto

En este ejemplo, se mueve un objeto de un bucket a otro.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción MoveObject y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"BucketSource": "aws-s3-bucket-source",
"ObjectSource": "abc.png",
"BucketDestination": "aws-s3-bucket-destination",
"ObjectDestination": "moved.png"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea MoveObject tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: actualiza la LCA de un bucket

En este ejemplo, se actualizan los permisos de control de acceso de un bucket.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción PutBucketAcl y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"BucketSource": "aws-s3-bucket-source",
"ACL": "public-read"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea PutBucketAcl tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplo: actualiza la LCA de un objeto

En este ejemplo, se actualizan los permisos de control de acceso de un objeto en un bucket.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción PutObjectAcl y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Bucket": "aws-s3-bucket-source",
"ACL": "aws-exec-read",
"Key": "AWS_S3_BusinessCase_V2.xlsx"
}

    4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea PutObjectAcl tendrá un valor similar al siguiente:

    [{
"Status": "Success"
}]

Ejemplos de operaciones de entidades

En esta sección, se muestra cómo realizar algunas de las operaciones de entidad en este conector.

Ejemplo: enumera los metadatos de todos los objetos

En este ejemplo, se recuperan los metadatos de todos los objetos de la entidad Object.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Object de la lista Entity.
  3. Selecciona la operación List y, luego, haz clic en Listo.
  4. De manera opcional, en la sección Entrada de la tarea de la tarea Conectores, puedes filtrar tu conjunto de resultados especificando una cláusula de filtro. Especifica el valor de la cláusula de filtro siempre entre comillas simples ('). Por ejemplo, Bucket='test-bucket'. También puedes especificar varias condiciones de filtro con los operadores lógicos. Por ejemplo, Bucket='test-bucket' and OwnerId='b1ecc809ad8467088afb'.

Ejemplo: obtén metadatos de un bucket

En este ejemplo, se obtienen los metadatos del bucket con el ID especificado de la entidad Bucket.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Bucket de la lista Entity.
  3. Selecciona la operación Get y, luego, haz clic en Listo.
  4. En la sección Task Input de la tarea Conectores, haz clic en EntityId y, luego, ingresa demo_replication en el campo Valor predeterminado.

    Aquí, demo_replication es un ID de bucket único en la entidad Bucket.

Ejemplo: Crea un bucket

En este ejemplo, se crea un bucket en la entidad Bucket.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Bucket de la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Bucket": "Demo1697528098686",
"OwnerId": "b1ecc809ad8467088afb6beed9581815e4f203f70d19553de2e5d23623ac6647",
"OwnerDisplayName": "awsr_adm.cpp"
}

    Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
"Bucket": "Demo1697528098686"
}]

Ejemplo: borra un bucket

En este ejemplo, se borra el bucket con el ID especificado en la entidad Bucket.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Bucket de la lista Entity.
  3. Selecciona la operación Delete y haz clic en Listo.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y, luego, ingresa demo1697528098686 en el campo Valor predeterminado.

Usa la conexión de Amazon S3 en una integración

Después de crear la conexión, estará disponible en Apigee Integration y en Application Integration. Puedes usar la conexión en una integración mediante la tarea Conectores.

  • Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta la Tarea Conectores.
  • Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la tarea Conectores.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?