Exportar archivos a Amazon S3

🤖/s3/store exporta resultados de encoding a Amazon S3.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowTransloaditToStoreFilesIn{BUCKET_NAME}Bucket",
      "Effect": "Allow",
      "Action": ["s3:GetBucketLocation", "s3:ListBucket", "s3:PutObject", "s3:PutObjectAcl"],
      "Resource": ["arn:aws:s3:::{BUCKET_NAME}", "arn:aws:s3:::{BUCKET_NAME}/*"]
    }
  ]
}

Ejemplo de uso

{
  "steps": {
    "exported": {
      "credentials": "YOUR_AWS_CREDENTIALS",
      "path": "my_target_folder/${unique_prefix}/${file.url_name}",
      "robot": "/s3/store",
      "use": ":original"
    }
  }
}

Parámetros

• interpolate

  boolean | Record<string, boolean>

  Controla si las Assembly Variables se interpolan en campos de instrucciones individuales.

  De forma predeterminada, la mayoría de los campos de instrucciones de los Robots interpolan Assembly Variables. Establece esta opción en false para tratar todos los campos de instrucciones como texto literal, o establece la ruta de un campo individual en false para tratar únicamente ese campo como texto literal. En el caso de los campos específicos de un Robot que son literales de forma predeterminada, establece esta opción en true o la ruta de ese campo en true para volver a habilitar la interpolación.

  Usa nombres de campos como path o rutas con puntos como ffmpeg.vf para los objetos anidados.

• output_meta

  Record<string, boolean> | boolean | Array<string>

  Te permite especificar un conjunto de metadatos cuyo cálculo requiere más recursos de CPU y que, por lo tanto, está desactivado de forma predeterminada para mantener el procesamiento de tus Assemblies rápido.

  Para imágenes, puedes añadir "has_transparency": true en este objeto para extraer si la imagen contiene partes transparentes y "dominant_colors": true para extraer un array de códigos de color hexadecimales de la imagen.

  Para imágenes, también puedes añadir "blurhash": true para extraer una cadena BlurHash⁠, una representación compacta de un marcador de posición para la imagen que resulta útil para mostrar una vista previa desenfocada mientras se carga la imagen completa.

  Para imágenes, "thumbhash": true extrae en su lugar un ThumbHash⁠ codificado en base64 en meta.thumbhash, junto con meta.has_alpha (si existe un canal alfa, incluso cuando es totalmente opaco). Describe píxeles orientados según EXIF y usa el primer fotograma en el caso de imágenes animadas. La extracción se realiza según el mejor esfuerzo posible: las imágenes de más de 40 megapíxeles, los formatos no compatibles o una decodificación fallida o limitada no generan ningún marcador de posición. Una extracción exitosa añade un cargo de metadatos equivalente al 20 % de los bytes de ese archivo. No se aplica ningún recargo por ThumbHash cuando está desactivado o cuando no se genera ningún hash.

  Configura esta opción en el Step que genera la imagen, como /upload/handle para los originales subidos o /image/resize para las salidas procesadas. Configurarla únicamente en /transloadit/store no solicita la extracción: el almacenamiento conserva los metadatos del origen. Transloadit Storage conserva un hash generado junto con su versión inmutable y lo devuelve en los resultados almacenados y en las lecturas nativas de activos. Las subidas directas a S3 no generan marcadores de posición. Un marcador de posición contiene información de la imagen, por lo que debes protegerlo con los mismos controles de acceso que la imagen completa.

  Para videos, puedes añadir el parámetro "colorspace": true para extraer el espacio de color del video de salida.

  Para videos, también puedes añadir "interlaced": true para detectar si el video está entrelazado. Esto combina el indicador field_order de ffprobe, cuyo costo computacional es bajo, con una pasada de muestreo limitada mediante idet sobre los primeros fotogramas de la fuente, y expone interlaced, field_order y un objeto de diagnóstico interlace_detection en file.meta. Esto requiere muchos recursos computacionales y se factura en consecuencia.

  Para audio, puedes añadir "mean_volume": true para obtener un único valor que represente el volumen promedio del archivo de audio.

  También puedes establecer esto en false para omitir la extracción de metadatos y acelerar la transcodificación.

• user_meta

  Record<string, any>(valor predeterminado: {})

  Añade metadatos JSON personalizados a cada archivo emitido sin modificar su contenido. Se admiten objetos y arrays anidados.

  La herencia depende del Robot. Los valores se combinan con los user_meta existentes en el archivo de salida; el Step actual reemplaza las claves coincidentes de nivel superior. Asigna explícitamente las claves necesarias cuando un Robot cree nuevos archivos de salida.

  En los Steps de procesamiento, ${file.*} hace referencia a la primera entrada y ${result.*} al archivo emitido. Los valores se evalúan para cada salida después de ejecutarse el Robot, antes de la posterior extracción de metadatos y del almacenamiento temporal. En :original, los valores se evalúan para cada subida antes de la extracción de metadatos.

  Los Steps posteriores leen ${file.user_meta.key}. Consulta Metadatos personalizados para ver un ejemplo completo y las reglas de herencia.

• result

  boolean(valor predeterminado: false)

  Indica si los resultados de este Step deben aparecer en el Assembly Status JSON

• queue

  batch

  Establecer la cola en «batch» reduce manualmente la prioridad de los Jobs de este Step para evitar consumir cupos prioritarios con Jobs que no necesitan un tiempo de espera cero en la cola

• force_accept

  boolean(valor predeterminado: false)

  Forzar a un Robot a aceptar un tipo de archivo que habría ignorado.

  De forma predeterminada, los Robots ignoran los archivos que no reconocen. 🤖/video/encode, por ejemplo, ignorará sin problemas las imágenes de entrada.

  Si configuras el parámetro force_accept como true, puedes forzar a los Robots a aceptar todos los archivos que reciban. Esto normalmente provocará errores y solo debe usarse para depuración o para abordar casos extremos.

• ignore_errors

  boolean | Array<meta | execute>(valor predeterminado: [])

  Ignorar errores durante fases específicas del procesamiento.

  Establecer este parámetro en ["meta"] hará que el Robot ignore los errores durante la extracción de metadatos.

  Establecer este parámetro en ["execute"] hará que el Robot ignore los errores durante la fase principal de ejecución.

  Configurar este parámetro como true equivale a ["meta", "execute"] y hará que se ignoren los errores en ambas fases.

• use

  string | Array<string> | Array<object> | object

  Especifica qué Step o Steps se usarán como entrada.

  • Puedes elegir cualquier nombre para los Steps, excepto ":original" (reservado para las subidas de usuarios gestionadas por Transloadit)
  • Puedes proporcionar varios Steps como entrada mediante arrays:

    {
      "use": [
        ":original",
        "encoded",
        "resized"
      ]
    }
    

  • También puedes etiquetar los Steps de entrada con as para comunicar la intención semántica a los Robots:

    {
      "use": [
        {
          "name": ":original",
          "as": "image"
        },
        {
          "name": ":original",
          "as": "mask"
        }
      ]
    }
    

  Consejo

  Probablemente eso sea todo lo que necesitas saber sobre use, pero puedes consultar los casos de uso avanzados.

• credentials

  string

  Crea las credenciales de Template asociadas en tu cuenta de Transloadit y usa el nombre de esas credenciales de Template como valor de este parámetro. Contendrán los valores de bucket, key, secret y bucket_region para S3.

  Aunque recomendamos usar siempre credenciales de Template, algunos casos de uso requieren credenciales dinámicas para las que resulta demasiado engorroso usar credenciales de Template debido a su naturaleza estática. Si tienes este requisito, puedes usar en su lugar los siguientes parámetros: "bucket", "bucket_region" (por ejemplo: "us-east-1" o "eu-west-2"), "key", "secret".

• path

  string(valor predeterminado: "${unique_prefix}/${file.url_name}")

  La ruta donde se almacenará el archivo. Puede incluir cualquiera de las variables de Assembly disponibles. La ruta no debe ser un directorio.

• url_prefix

  string(valor predeterminado: "http://{bucket}.s3.amazonaws.com/")

  El prefijo de URL usado para la URL devuelta, como "http://my.cdn.com/some/path/".

• acl

  bucket-default | private | public | public-read(valor predeterminado: "public-read")

  Los permisos utilizados para este archivo.

  Ten en cuenta que el valor predeterminado "public-read" puede provocar errores de permisos debido a la casilla "Block all public access", que está marcada de forma predeterminada al crear un nuevo bucket de Amazon S3 en la consola de AWS.

• check_integrity

  boolean(valor predeterminado: false)

  Calcula y envía la suma de comprobación del archivo para que S3 verifique su integridad después de la subida, lo que puede ayudar con problemas ocasionales de archivos dañados.

  Activar esta opción aumenta el tiempo total de ejecución, ya que la comprobación de integridad puede requerir un uso intensivo de la CPU, especialmente con archivos más grandes.

• headers

  Record<string, string>(valor predeterminado: {"Content-Type":"${file.mime}"})

  Un objeto que contiene una lista de encabezados que se establecerán para este archivo en S3, como { FileURL: "${file.url_name}" }. También puede incluir cualquiera de las variables de Assembly disponibles. Puedes consultar una lista de los encabezados disponibles aquí⁠.

  Los metadatos del objeto pueden especificarse mediante encabezados x-amz-meta-*. Ten en cuenta que estos encabezados no admiten valores de metadatos que no sean ASCII⁠.

• tags

  Record<string, string>(valor predeterminado: {})

  El etiquetado de objetos te permite categorizar el almacenamiento. Puedes asociar hasta 10 etiquetas con un objeto. Las etiquetas asociadas con un objeto deben tener claves únicas.

• host

  string(valor predeterminado: "s3.amazonaws.com")

  El host del servicio de almacenamiento utilizado. Solo es necesario establecerlo cuando el servicio de almacenamiento no es Amazon S3, pero tiene una API compatible (como hosteurope.de). El protocolo predeterminado es HTTP; para cualquier otro, debes especificarlo explícitamente. Por ejemplo, antepón al host https:// o s3:// para usar el protocolo correspondiente.

• no_vhost

  boolean(valor predeterminado: false)

  Establécelo en true si utilizas un host personalizado y se producen errores de acceso denegado.

• sign_urls_for

  string | number

  Este parámetro proporciona URL firmadas en el JSON de resultados (en las propiedades signed_url y signed_ssl_url). El número que establezcas como valor de este parámetro será el tiempo de expiración de la URL en segundos. Si no se utiliza este parámetro, no se firma ninguna URL.

• session_token

  string

  El token de sesión que se utilizará para el almacenamiento en S3. Solo se utiliza si las credenciales pertenecen a un usuario de IAM con el permiso sts:AssumeRole.

Demos

Publicaciones relacionadas del blog