Exportar arquivos para o Amazon S3

🤖/s3/store exporta resultados de codificação para o 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}/*"]
    }
  ]
}

Exemplo 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 se as Assembly Variables são interpoladas em campos individuais de instruções.

  Por padrão, a maioria dos campos de instruções dos Robots interpola Assembly Variables. Defina isso como false para tratar todos os campos de instruções como texto literal, ou defina o caminho de um campo individual como false para tratar apenas esse campo como texto literal. Para campos específicos de um Robot que são literais por padrão, defina isso como true ou defina o caminho desse campo como true para voltar a usar a interpolação.

  Use nomes de campos como path ou caminhos com pontos como ffmpeg.vf para objetos aninhados.

• output_meta

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

  Permite especificar um conjunto de metadados cujo cálculo exige mais CPU e que, por isso, vem desativado por padrão para manter o processamento das suas Assemblies rápido.

  Para imagens, você pode adicionar "has_transparency": true neste objeto para extrair se a imagem contém partes transparentes e "dominant_colors": true para extrair um array de códigos de cores hexadecimais da imagem.

  Para imagens, você também pode adicionar "blurhash": true para extrair uma string BlurHash⁠ — uma representação compacta de um placeholder da imagem, útil para exibir uma prévia desfocada enquanto a imagem completa carrega.

  Para vídeos, você pode adicionar o parâmetro "colorspace": true para extrair o espaço de cores do vídeo de saída.

  Para vídeos, você também pode adicionar "interlaced": true para detectar se o vídeo é entrelaçado. Isso combina a flag computacionalmente barata field_order do ffprobe com uma passagem de amostragem idet limitada sobre os primeiros quadros da origem, expondo interlaced, field_order e um objeto de diagnóstico interlace_detection em file.meta. Isso é computacionalmente caro e cobrado de acordo.

  Para áudio, você pode adicionar "mean_volume": true para obter um único valor que representa o volume médio do arquivo de áudio.

  Você também pode definir isso como false para pular a extração de metadados e acelerar a transcodificação.

• user_meta

  Record<string, any>(padrão: {})

  Adiciona metadados JSON personalizados a cada arquivo emitido sem modificar seu conteúdo. Objetos e arrays aninhados são suportados.

  A herança depende do Robot. Os valores são mesclados com o user_meta existente no arquivo de saída; o Step atual substitui as chaves de nível superior com o mesmo nome. Atribua explicitamente as chaves necessárias quando um Robot criar novas saídas.

  Nos Steps de processamento, ${file.*} se refere à primeira entrada e ${result.*} ao arquivo emitido. Os valores são avaliados para cada saída após a execução do Robot, antes da extração subsequente de metadados e do armazenamento temporário. Em :original, os valores são avaliados para cada upload antes da extração de metadados.

  Os Steps subsequentes leem ${file.user_meta.key}. Consulte Metadados personalizados para ver um exemplo completo e as regras de herança.

• result

  boolean(padrão: false)

  Se os resultados deste Step devem estar presentes no Assembly Status JSON

• queue

  batch

  Definir a fila como “batch” rebaixa manualmente a prioridade dos Jobs deste Step, para evitar o consumo de vagas prioritárias de Jobs em Jobs que não precisam de tempo zero de espera na fila

• force_accept

  boolean(padrão: false)

  Forçar um Robot a aceitar um tipo de arquivo que ele teria ignorado.

  Por padrão, os Robots ignoram arquivos que não conhecem. O 🤖/video/encode, por exemplo, ignora tranquilamente imagens de entrada.

  Com o parâmetro force_accept definido como true, você pode forçar os Robots a aceitar todos os arquivos enviados a eles. Isso normalmente leva a erros e só deve ser usado para depuração ou para lidar com casos extremos.

• ignore_errors

  boolean | Array<meta | execute>(padrão: [])

  Ignorar erros durante fases específicas do processamento.

  Definir isso como ["meta"] fará com que o Robot ignore erros durante a extração de metadados.

  Definir isso como ["execute"] fará com que o Robot ignore erros durante a fase principal de execução.

  Definir isso como true equivale a ["meta", "execute"] e fará com que erros sejam ignorados nas duas fases.

• use

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

  Especifica quais Steps usar como entrada.

  • Você pode escolher qualquer nome para os Steps, exceto ":original" (reservado para uploads de usuários tratados pela Transloadit)
  • Você pode fornecer vários Steps como entrada usando arrays:

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

  • Você também pode marcar os Steps de entrada com as para transmitir intenção semântica aos Robots:

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

  Dica

  Provavelmente é tudo o que você precisa saber sobre use, mas você pode ver os casos de uso avançados.

• credentials

  string

  Crie as credenciais de Template correspondentes na sua conta da Transloadit e use o nome das suas credenciais de Template como valor deste parâmetro. Elas conterão os valores de bucket, key, secret e bucket_region do seu S3.

  Embora recomendemos sempre usar credenciais de Template, alguns casos de uso exigem credenciais dinâmicas, para os quais o uso de credenciais de Template é pouco prático devido à sua natureza estática. Se você tiver essa necessidade, pode usar os seguintes parâmetros no lugar delas: "bucket", "bucket_region" (por exemplo: "us-east-1" ou "eu-west-2"), "key", "secret".

• path

  string(padrão: "${unique_prefix}/${file.url_name}")

  O caminho no qual o arquivo será armazenado. Ele pode incluir quaisquer Assembly Variables disponíveis. O caminho não deve ser um diretório.

• url_prefix

  string(padrão: "http://{bucket}.s3.amazonaws.com/")

  O prefixo de URL usado para a URL retornada, como "http://my.cdn.com/some/path/".

• acl

  bucket-default | private | public | public-read(padrão: "public-read")

  As permissões usadas para este arquivo.

  Lembre-se de que o valor padrão "public-read" pode causar erros de permissão devido à caixa de seleção "Block all public access", que fica marcada por padrão ao criar um novo bucket Amazon S3 no console da AWS.

• check_integrity

  boolean(padrão: false)

  Calcule e envie a soma de verificação do arquivo para que o S3 verifique sua integridade após o upload, o que pode ajudar com problemas ocasionais de corrupção de arquivos.

  Habilitar esta opção aumenta o tempo total de execução, pois a verificação de integridade pode exigir uso intensivo de CPU, especialmente para arquivos maiores.

• headers

  Record<string, string>(padrão: {"Content-Type":"${file.mime}"})

  Um objeto contendo uma lista de cabeçalhos a serem definidos para este arquivo no S3, como { FileURL: "${file.url_name}" }. Isso também pode incluir quaisquer Assembly Variables disponíveis. Você pode encontrar uma lista de cabeçalhos disponíveis aqui⁠.

  Os metadados do objeto podem ser especificados usando cabeçalhos x-amz-meta-*. Observe que esses cabeçalhos não aceitam valores de metadados com caracteres fora de ASCII⁠.

• tags

  Record<string, string>(padrão: {})

  A marcação de objetos com tags permite categorizar o armazenamento. Você pode associar até 10 tags a um objeto. As tags associadas a um objeto devem ter chaves de tag exclusivas.

• host

  string(padrão: "s3.amazonaws.com")

  O host do serviço de armazenamento usado. Só é necessário definir este parâmetro quando o serviço de armazenamento usado não é o Amazon S3, mas tem uma API compatível (como hosteurope.de). O protocolo padrão usado é HTTP; para qualquer outro, o protocolo precisa ser especificado explicitamente. Por exemplo, adicione o prefixo https:// ou s3:// ao host para usar o protocolo correspondente.

• no_vhost

  boolean(padrão: false)

  Defina como true se você usar um host personalizado e encontrar erros de acesso negado.

• sign_urls_for

  string | number

  Este parâmetro fornece URLs assinadas no JSON de resultado (nas propriedades signed_url e signed_ssl_url). O número definido neste parâmetro é o prazo de expiração da URL em segundos. Se este parâmetro não for usado, nenhuma assinatura de URL será realizada.

• session_token

  string

  O token de sessão a ser usado para o armazenamento no S3. Ele só é usado se as credenciais forem de um usuário IAM com a permissão sts:AssumeRole.

Demonstrações

Publicações relacionadas no blog