Referência: parâmetros de definição de trabalho para ContainerProperties

Ao registrar uma definição de trabalho, você especifica um nome. Os nomes podem ter até 128 caracteres. Pode conter letras minúsculas, maiúsculas, números, hifens e (-) e sublinhados (_). A primeira definição de trabalho que está registrada com esse nome recebe uma revisão de 1. Todas as definições de trabalho subsequentes registrados com esse nome recebem um número de revisão incremental.

Tipo: Sequência

Obrigatório: Sim

Ao registrar uma definição de trabalho, você especifica o tipo de trabalho. Se o trabalho for executado em recursos do Fargate, então multinode não será compatível. Para obter mais informações sobre trabalho em paralelo com vários nós, consulte Criar uma definição de trabalho paralelo de vários nós.

Tipo: Sequência

Valores válidos: container | multinode

Obrigatório: Sim

Quando você envia um trabalho, pode especificar os parâmetros que devem substituir os marcadores ou os parâmetros de definição de trabalho padrão. Os parâmetros nas solicitações de envio de trabalho têm precedência sobre os padrões em uma definição de trabalho. Isso significa que você pode usar a mesma definição de trabalho para vários outros que usam o mesmo formato. Você também pode alterar programaticamente os valores no comando no momento do envio.

Tipo: Mapa de string para string

Obrigatório: Não

Ao registrar uma definição de trabaho, você pode usar espaços reservados para substituição de parâmetros no campo command de propriedades de contêiner de um trabalho. A sintaxe é a seguinte.

"command": [
    "ffmpeg",
    "-i",
    "Ref::inputfile",
    "-c",
    "Ref::codec",
    "-o",
    "Ref::outputfile"
]

No exemplo acima, há os espaços reservados de substituição de parâmetro Ref::inputfile, Ref::codec e Ref::outputfile no comando. Você pode usar o objeto parameters na definição do trabalho para configurar valores padrão para esses espaços reservados. Por exemplo, para definir um padrão para o espaço reservado Ref::codec, você especificará o seguinte na definição do trabalho:

"parameters" : {"codec" : "mp4"}

Quando essa definição de trabalho for enviada para execução, o argumento Ref::codec no comando para o contêiner será substituído pelo valor padrão, mp4.

O comando que é passado para o contêiner. Esse parâmetro é mapeado para Cmd na seção Criar um contêiner da Docker Remote API e o parâmetro COMMAND de docker run. Para obter mais informações sobre o parâmetro CMD da Docker, consulte https://docs.docker.com/engine/reference/builder/#cmd.

"command": ["string", ...]

Tipo: Matriz de strings

Obrigatório: Não

As variáveis de ambiente a serem passadas para um contêiner. Esse parâmetro é mapeado para Env na seção Criar um contêiner da Docker Remote API e a opção --env para docker run.

Tipo: Matriz de pares de valores-chave

Obrigatório: Não

"environment" : [
    { "name" : "envName1", "value" : "envValue1" },
    { "name" : "envName2", "value" : "envValue2" }
]

Ao registrar uma definição de trabalho, você pode especificar um perfil do IAM. O perfil fornece ao agente de contêiner do Amazon ECS permissões para chamar as ações da API especificadas nas políticas colaboradoras em seu nome. Para trabalhos executados em recursos do Fargate, você deve fornecer um perfil de execução. Para ter mais informações, consulte Função de execução do AWS Batch IAM.

Tipo: Sequência

Obrigatório: Não

A configuração da plataforma para trabalhos que são executados nos recursos do Fargate. Os trabalhos que são executados nos recursos do EC2 não devem especificar esse parâmetro.

Tipo: Objeto FargatePlatformConfiguration

Obrigatório: Não

A imagem usada para iniciar um trabalho. Esta string é passada diretamente para o daemon do Docker. As imagens no registro do Docker Hub estão disponíveis por padrão. Você também pode especificar outros repositórios com repository-url/image:tag. São permitidos até 255 letras (caixa alta e baixa), números, hifens, sublinhados, dois pontos, ponto, barras e sinais numéricos. Esse parâmetro é mapeado para Image na seção Criar um contêiner da Docker Remote API e o parâmetro IMAGE de docker run.

Tipo: Sequência

Obrigatório: Sim

O tipo de instância a ser usado para trabalhos paralelos de vários nós. Atualmente, todos os grupos de nós em um trabalho em paralelo de vários nós devem usar o mesmo tipo de instância. Esse parâmetro não é válido para trabalhos de contêiner de nó único ou para trabalhos que são executados em recursos Fargate.

Tipo: Sequência

Obrigatório: Não

Ao registrar uma definição de trabalho, você pode especificar um perfil do IAM. A função fornece ao contêiner de trabalho permissões para chamar as ações da API especificadas em suas políticas colaboradoras em seu nome. Para obter mais informações, consulte Perfis do IAM para tarefas no Guia do desenvolvedor do Amazon Elastic Container Service.

Tipo: Sequência

Obrigatório: Não

Modificações específicas do Linux que são aplicadas ao contêiner, como detalhes para mapeamentos do dispositivo.

"linuxParameters": {
    "devices": [
        {
            "hostPath": "string",
            "containerPath": "string",
            "permissions": [
                "READ", "WRITE", "MKNOD"
            ]
        }
    ],
    "initProcessEnabled": true|false,
    "sharedMemorySize": 0,
    "tmpfs": [
        {
            "containerPath": "string",
            "size": integer,
            "mountOptions": [
                "string"
            ]
        }
    ],
    "maxSwap": integer,
    "swappiness": integer
}

Tipo: Objeto LinuxParameters

Obrigatório: Não

A especificação de configuração do log para o contêiner.

Esse parâmetro é mapeado LogConfig na seção Criar um contêiner da Docker Remote API e na opção --log-driver de execução do docker. Por padrão, os contêineres usam o mesmo driver de registro que o daemon do Docker usa. No entanto, o contêiner pode usar um driver de registro diferente do daemon do Docker especificando um driver de log com esse parâmetro na definição de contêiner. Para usar um driver de registro diferente para um contêiner, o sistema de registro deve ser configurado na instância de contêiner ou em outro servidor de registro para fornecer opções de registro remoto. Para obter mais informações sobre as opções para drivers de log compatíveis diferentes, consulte Configure logging drivers na documentação do Docker.

Este parâmetro requer a versão 1.18 da Docker Remote API ou posterior em sua instância de contêiner. Para verificar a versão da Docker Remote API na instância de contêiner, faça login na instância de contêiner e execute o seguinte comando: sudo docker version | grep "Server API version"

"logConfiguration": {
    "devices": [
        {
            "logDriver": "string",
            "options": {
                "optionName1" : "optionValue1",
                "optionName2" : "optionValue2"
            }
            "secretOptions": [
              {
                  "name" : "secretOptionName1",
                  "valueFrom" : "secretOptionArn1"
              },
              {
                  "name" : "secretOptionName2",
                  "valueFrom" : "secretOptionArn2"
              }
            ]
        }
    ]
}

Tipo: Objeto LogConfiguration

Obrigatório: Não

Este parâmetro está obsoleto, use resourceRequirements alternativamente.

O número de MiB de memória a ser reservado para o contêiner.

Como exemplo de como usar resourceRequirements, se sua definição de trabalho contiver uma sintaxe semelhante à seguinte.

"containerProperties": {
  "memory": 512
}

A sintaxe equivalente usando resourceRequirements é a seguinte.

"containerProperties": {
  "resourceRequirements": [
    {
      "type": "MEMORY",
      "value": "512"
    }
  ]
}

Tipo: Inteiro

Obrigatório: Sim

Os pontos de montagem para volumes de dados no contêiner. Esse parâmetro é mapeado para Volumes na seção Criar um contêiner da Docker Remote API e a opção --volume para docker run.

"mountPoints": [
                {
                  "sourceVolume": "string",
                  "containerPath": "string",
                  "readOnly": true|false
                }
              ]

Tipo: Matriz de objeto

Obrigatório: Não

A configuração de rede para trabalhos que estão em execução nos recursos do Fargate. Os trabalhos que são executados nos recursos do EC2 não devem especificar esse parâmetro.

"networkConfiguration": { 
   "assignPublicIp": "string"
}

Tipo: Matriz de objeto

Obrigatório: Não

Quando esse parâmetro é verdadeiro, o contêiner recebe permissões elevadas na instância de contêiner host (semelhante ao usuário root). Esse parâmetro é mapeado para Privileged na seção Criar um contêiner da Docker Remote API e a opção --privileged para docker run. Este parâmetro não é aplicável a trabalhos executados em recursos do Fargate. Não o forneça nem o especifique como falso.

"privileged": true|false

Tipo: Booliano

Obrigatório: Não

Quando esse parâmetro é verdadeiro, o contêiner recebe acesso somente leitura ao sistema de arquivos raiz. Esse parâmetro é mapeado para ReadonlyRootfs na seção Criar um contêiner da Docker Remote API e a opção --read-only para docker run.

"readonlyRootFilesystem": true|false

Tipo: Booliano

Obrigatório: Não

O tipo e a quantidade de um recurso a serem atribuídos a um contêiner. Os recursos suportados incluem GPU, MEMORY e VCPU.

"resourceRequirements" : [
  {
    "type": "GPU",
    "value": "number"
  }
]

Tipo: Matriz de objeto

Obrigatório: Não

Os segredos do trabalho que são expostos como variáveis de ambiente. Para ter mais informações, consulte Especificar dados confidenciais.

"secrets": [
    {
      "name": "secretName1",
      "valueFrom": "secretArn1"
    },
    {
      "name": "secretName2",
      "valueFrom": "secretArn2"
    }
    ...
]

Tipo: Matriz de objeto

Obrigatório: Não

Uma lista de valores ulimits a ser definida no contêiner. Esse parâmetro é mapeado para Ulimits na seção Criar um contêiner da Docker Remote API e a opção --ulimit para docker run.

"ulimits": [
  {
    "name": string,
    "softLimit": integer,
    "hardLimit": integer
  }
  ...
]

Tipo: Matriz de objeto

Obrigatório: Não

O nome de usuário a ser usado dentro do contêiner. Esse parâmetro é mapeado para User na seção Criar um contêiner da Docker Remote API e a opção --user para docker run.

"user": "string"

Tipo: Sequência

Obrigatório: Não

Este parâmetro está obsoleto, use resourceRequirements alternativamente.

O número de vCPUs reservado para o contêiner.

Como exemplo de como usar resourceRequirements, se sua definição de trabalho contiver linhas semelhantes a esta:

"containerProperties": {
  "vcpus": 2
}

As linhas equivalentes usadas resourceRequirements são as seguintes.

"containerProperties": {
  "resourceRequirements": [
    {
      "type": "VCPU",
      "value": "2"
    }
  ]
}

Tipo: Inteiro

Obrigatório: Sim

Ao registrar uma definição de trabalho, você pode especificar uma lista de volumes que são passados para o daemon do Docker em uma instância de contêiner. Os parâmetros a seguir são permitidos na propriedades de contêiner:

"volumes": [
  {
    "name": "string",
    "host": {
      "sourcePath": "string"
    },
    "efsVolumeConfiguration": {
      "authorizationConfig": {
        "accessPointId": "string",
        "iam": "string"
      },
      "fileSystemId": "string",
      "rootDirectory": "string",
      "transitEncryption": "string",
      "transitEncryptionPort": number
    }
  }
]

As propriedades dos recursos do pod Kubernetes de um trabalho.

Tipo: Objeto EksPodProperties

Obrigatório: Não

As funcionalidades da plataforma necessárias pela definição do cargo. Se nenhum valor for especificado, o padrão será EC2. Para trabalhos executados em recursos do Fargate, FARGATE é especificado.

Tipo: Sequência

Valores válidos: EC2 | FARGATE

Obrigatório: Não

Especifica se as tags devem ser propagadas a partir do trabalho ou da definição de trabalho para a tarefa correspondente do Amazon ECS. Se nenhum valor for especificado, as tags não serão propagadas. As tags só podem ser propagadas para as tarefas quando as tarefas são criadas. Para tags com o mesmo nome, as tags de trabalho têm prioridade sobre as tags de definições de trabalho. Se o número total de tags combinadas do trabalho e da definição do trabalho for superior a 50, o trabalho será movido para o estado FAILED.

Tipo: Booliano

Obrigatório: Não

Ao registrar uma definição de trabalho paralela de vários nós, você deve especificar uma lista de propriedades de nós. Essas propriedades do nó definem o número de nós a serem usados em seu trabalho, o índice do nó principal e os diferentes intervalos de nós a serem usados. Se o trabalho for executado em recursos do Fargate, não especifique nodeProperties. Em seu lugar, use containerProperties. As seguintes propriedades de nó são permitidas em uma definição de trabalho. Para ter mais informações, consulte Trabalhos em paralelo de vários nós.

Tipo: Objeto NodeProperties

Obrigatório: Não

Ao registrar uma definição de trabalho, você pode opcionalmente especificar uma estratégia de nova tentativa a ser usada para trabalhos com falha que são enviados com essa definição de trabalho. Qualquer estratégia de repetição especificada durante uma operação SubmitJob substitui a estratégia de repetição definida aqui. Por padrão, cada trabalho é tentado uma vez. Se você especificar mais de uma tentativa, o trabalho será repetido se falhar. Exemplos de uma tentativa de falha incluem o trabalho retornar um código de saída diferente de zero ou a instância de contêiner ser encerrada. Para ter mais informações, consulte Repetições de trabalho automatizadas.

Tipo: Objeto RetryStrategy

Obrigatório: Não

A prioridade de agendamento para trabalhos enviados com essa definição de trabalho. Isso afeta apenas os trabalhos nas filas de trabalhos com uma política de compartilhamento justo. Trabalhos com prioridade de agendamento mais alta são agendados antes de trabalhos com prioridade de agendamento mais baixa.

O valor mínimo compatível é 0 e o valor máximo compatível é 9999.

Tipo: Inteiro

Obrigatório: Não

Etiquetas de pares de valores-chave a serem associadas à definição do trabalho. Para ter mais informações, consulte Marcar com tag os recursos do AWS Batch.

Tipo: Mapa de string para string

Obrigatório: Não

Você pode configurar uma duração de tempo limite para os seus trabalhos para que, caso uma execução de trabalho seja maior, AWS Batch possa encerrar o trabalho. Para ter mais informações, consulte Tempos limite de trabalho. Se um trabalho for encerrado devido a um tempo limite, ele não será tentado novamente. Qualquer configuração de tempo limite especificada durante uma operação SubmitJob substituirá a configuração de tempo limite definida aqui. Para ter mais informações, consulte Tempos limite de trabalho.

Tipo: Objeto JobTimeout

Obrigatório: Não