Parâmetros de definição de tarefa do Amazon ECS

Tipo: string

Obrigatório: Sim

Ao registrar uma definição de tarefa, você dá a ela uma família, semelhante a um nome para várias versões da definição de tarefa, especificada com um número de revisão. A primeira definição de tarefa registrada em uma determinada família recebe uma revisão 1, e todas as definições de tarefa registradas depois receberão um número de revisão sequencial.

Tipo: Matriz de strings

Obrigatório: Não

Valores válidos: EC2 | FARGATE | EXTERNAL

O tipo de inicialização em relação à qual a definição de tarefa é validada. Isso inicia uma verificação para garantir que todos os parâmetros usados na definição de tarefa atendam aos requisitos do tipo de inicialização.

Tipo: string

Obrigatório: Não

Ao registrar uma definição de tarefa, você pode fornecer uma função de tarefa para uma função do IAM que permita que os contêineres da permissão de tarefa chame as APIs da AWS especificadas nas políticas associadas em seu nome. Para ter mais informações, consulte Perfil do IAM para tarefas do Amazon ECS.

Quando você inicia a AMI do Windows Server otimizada para o Amazon ECS, os perfis do IAM para tarefas no Windows exigem que a opção -EnableTaskIAMRole seja definida. Seus contêineres também devem executar algum código de configuração para usar o recurso. Para ter mais informações, consulte Configuração adicional de instância do Windows no Amazon EC2.

Tipo: string

Obrigatório: Condicional

O nome do recurso da Amazon (ARN) da função de execução de tarefas que concede ao agente de contêiner do Amazon ECS permissão para fazer chamadas de API da AWS em seu nome.

Tipo: string

Obrigatório: Não

O modo de rede do Docker a ser usado para os contêineres na tarefa. Para tarefas do Amazon ECS hospedadas em instâncias do Linux do Amazon EC2, os valores válidos são none, bridge, awsvpc e host. Se nenhum modo de rede for especificado, o modo de rede padrão será bridge. Para tarefas do Amazon ECS hospedadas em instâncias do Windows do Amazon EC2, os valores válidos são default e awsvpc. Se nenhum modo de rede for especificado, o modo de rede default será usado. Para tarefas do Amazon ECS hospedadas no Fargate, é necessário o modo de rede awsvpc.

Caso o modo de rede estiver definido como none, os contêineres da tarefa não terão conectividade externa e os mapeamentos de porta não poderão ser especificados na definição de contêiner.

Se o modo da rede for bridge, a tarefa usará a rede virtual integrada do Docker no Linux, que é executada em cada instância do Amazon EC2 que hospeda a tarefa. A rede virtual integrada no Linux usa o driver de rede bridge do Docker.

Se o modo de rede for host, a tarefa usará a rede do host que ignora a rede virtual integrada do Docker mapeando as portas de contêiner diretamente para a ENI da instância do Amazon EC2 que hospeda a tarefa. Os mapeamentos dinâmicos de portas não podem ser usados nesse modo de rede. Um contêiner em uma definição de tarefa que use esse modo deve especificar um número de hostPort específico. Um número de porta em um host não pode ser usado por várias tarefas. Como resultado, não é possível executar várias tarefas da mesma definição de tarefa em uma única instância do Amazon EC2.

Para os tipos de execução do Amazon EC2, quando o modo de rede é awsvpc, a tarefa recebe uma interface de rede elástica e você deve especificar uma NetworkConfiguration ao criar um serviço ou executar uma tarefa com a definição de tarefa. Para ter mais informações, consulte Opções de redes de tarefas do Amazon ECS para o tipo de inicialização do EC2.

Se o modo da rede for default, a tarefa usará a rede virtual integrada do Docker no Windows, que é executada em cada instância do Amazon EC2 que hospeda a tarefa. A rede virtual integrada no Windows usa o driver de rede nat do Docker.

Para os tipos de execução do Fargate, quando o modo de rede é awsvpc, a tarefa recebe uma interface de rede elástica e você deve especificar uma NetworkConfiguration ao criar um serviço ou executar uma tarefa com a definição de tarefa. Para obter mais informações, consulte Fargate Task Networking. O modo de rede awsvpc oferece a melhor performance de rede para contêineres, pois usa a pilha de rede do Amazon EC2. As portas do contêiner expostas são mapeadas diretamente para a porta da interface de rede elástica conectada. Por causa disso, não é possível usar mapeamentos dinâmicos de portas de host.

Os modos de rede host e awsvpc oferecem a melhor performance de rede para contêineres, pois usam a pilha de rede do Amazon EC2. Com os modos de rede host e awsvpc, as portas do contêiner expostas são mapeadas diretamente para a porta do host correspondente (para o modo de rede do host) ou para a porta de interface de rede elástica anexada (para o modo de rede awsvpc). Por causa disso, não é possível usar mapeamentos dinâmicos de portas de host.

Se você estiver usando o tipo de inicialização do Fargate, será necessário o modo de rede awsvpc. Se você estiver usando o tipo de inicialização do EC2, o modo de rede permitido depende do sistema operacional da instância do EC2 subjacente. Se for o Linux, qualquer modo de rede pode ser usado. Se for o Windows, podem ser usados os modos default e awsvpc.

Tipo: string

Obrigatório: Condicional

Padrão: LINUX

Esse parâmetro é necessário para tarefas do Amazon ECS hospedadas no Fargate.

Ao registrar uma definição de tarefa, você especifica a família do sistema operacional.

Os valores válidos para tarefas do Amazon ECS hospedadas no Fargate são LINUX, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2022_FULL e WINDOWS_SERVER_2022_CORE.

Os valores válidos para tarefas do Amazon ECS hospedadas no EC2 são LINUX, WINDOWS_SERVER_2022_CORE, WINDOWS_SERVER_2022_FULL, WINDOWS_SERVER_2019_FULL e WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2016_FULL, WINDOWS_SERVER_2004_CORE e WINDOWS_SERVER_20H2_CORE.

Todas as definições de tarefa usadas em um serviço devem ter o mesmo valor para esse parâmetro.

Quando uma definição de tarefa faz parte de um serviço, esse valor deve corresponder ao valor platformFamily do serviço.

Tipo: string

Obrigatório: Condicional

Padrão: X86_64

Esse parâmetro é necessário para tarefas do Amazon ECS hospedadas no Fargate. Se o parâmetro for deixado como null, o valor padrão é atribuído automaticamente ao iniciar uma tarefa hospedada no Fargate.

Ao registrar uma definição de tarefa, você especifica a arquitetura da CPU. Os valores válidos são X86_64 e ARM64.

Todas as definições de tarefa usadas em um serviço devem ter o mesmo valor para esse parâmetro.

Quando você tem tarefas do Linux para o tipo de inicialização do Fargate ou para o tipo de inicialização do EC2, você pode definir o valor como ARM64. Para ter mais informações, consulte Definições de tarefa do Amazon ECS para workloads do ARM de 64 bits.

Tipo: string

Obrigatório: Condicional

O limite rígido de unidades de CPU a ser apresentado para a tarefa. Você pode especificar valores de CPU no arquivo JSON como uma string em unidades de CPU ou em CPUs virtuais (vCPUs). Por exemplo, você pode especificar um valor de CPU como 1024 em unidades de CPU ou 1 vCPU em vCPUs. Quando a definição de tarefa for registrada, um valor de vCPU será convertido em um inteiro indicando as unidades de CPU.

Para tarefas executadas em instâncias do EC2 ou em instâncias externas, este campo é opcional. Se o seu cluster não tiver registrado instâncias de contêiner com as unidades de CPU solicitadas disponíveis, ocorrerá uma falha na tarefa. Os valores com suporte para tarefas executadas em instâncias do EC2 ou em instâncias externas estão entre 0.125 vCPUs e 10 vCPUs.

Para tarefas executadas no Fargate (tanto contêineres do Linux quanto do Windows), este campo é obrigatório e você deve usar um dos valores a seguir, o que determina seu intervalo de valores com suporte para o parâmetro memory. A tabela a seguir mostra as combinações válidas para CPU e memória em nível de tarefa.

Tipo: string

Obrigatório: Condicional

O limite fixo de memória a ser apresentada para a tarefa. É possível especificar valores de memória na definição de tarefa como uma string em mebibytes (MiB) ou gigabytes (GB). Por exemplo, você pode especificar um valor de memória como 3072 em MiB ou 3 GB em GB. Quando a definição de tarefa for registrada, um valor em GB será convertido em um inteiro indicando o MiB.

Para tarefas hospedadas em instâncias do Amazon EC2, esse campo é opcional e qualquer valor pode ser usado. Se um valor de memória no nível de tarefa for especificado, o valor de memória no nível de contêiner será opcional. Se o seu cluster não tiver registrado instâncias de contêiner com a memória solicitada disponível, ocorrerá uma falha na tarefa. É possível maximizar a utilização de recursos fornecendo às tarefas o máximo de memória possível para um determinado tipo de instância. Para ter mais informações, consulte Reserva de memória da instância de contêiner do Linux no Amazon ECS.

Para tarefas hospedadas no Fargate (tanto contêineres de Linux quanto de Windows), esse campo é obrigatório e você deve usar um dos seguintes valores, o que determina seu intervalo de valores com suporte com o parâmetro cpu:

Tipo: string

Obrigatório: Sim

O nome de um contêiner. São permitidos até 255 letras (caixa alta e baixa), números, hífens e sublinhados. Se estiver vinculando vários contêineres em uma definição de tarefa, o name de um contêiner poderá ser informado no links de outro contêiner. Isso deve ser feito para conectar os contêineres.

Tipo: string

Obrigatório: Sim

A imagem usada para iniciar um contêiner. Essa string é passada diretamente para o daemon do Docker. Por padrão, as imagens no registro do Docker Hub estão disponíveis. Você também pode especificar outros repositórios com repository-url/image:tag ou repository-url/image@digest. 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 no comando create-container do docker e no parâmetro IMAGE do comando run do docker.

Tipo: string

Valores válidos: enabled|disabled

Obrigatório: Não

Especifica se o Amazon ECS resolverá a tag de imagem do contêiner fornecida na definição do contêiner em um resumo de imagem. Por padrão, esse comportamento é enabled. Se você definir o valor de um contêiner como disabled, o Amazon ECS não resolverá a tag da imagem do contêiner como um resumo e usará o URI da imagem original especificado na definição do contêiner para implantação. Para obter mais informações sobre resolução de imagem do contêiner, consulte Resolução da imagem do contêiner.

Tipo: número inteiro

Obrigatório: Não

A quantidade (em MiB) de memória a ser apresentada ao contêiner. Caso tente exceder a memória especificada aqui, o contêiner será excluído. A quantidade total de memória reservada para todos os contêineres dentro da tarefa deve ser menor que o valor da tarefa memory, se estiver especificado. Esse parâmetro é mapeado para Memory no comando create-container do docker na opção --memory de execução do docker.

Se estiver usando o tipo de inicialização Fargate, esse parâmetro será opcional.

Se estiver usando o tipo de inicialização do EC2, será necessário especificar um valor de memória em nível de tarefa ou um valor de memória em nível do contêiner. Se você especificar um nível de contêiner memory e um valor de memoryReservation, o valor de memory deverá ser maior que o valor de memoryReservation. Caso você especifique memoryReservation, o valor é subtraído dos recursos de memória disponíveis para a instância de contêiner na qual o contêiner está colocado. Caso contrário, o valor de memory é usado.

O daemon para Docker 20.10.0 ou versão posterior reserva no mínimo 6 MiB de memória para um contêiner. Por isso, não especifique menos de 6 MiB de memória para os seus contêineres.

O daemon para Docker 19.03.13-ce ou versão anterior reserva no mínimo 4 MiB de memória para um contêiner. Por isso, não especifique menos de 4 MiB de memória para os seus contêineres.

Tipo: número inteiro

Obrigatório: Não

O limite flexível (em MiB) de memória a ser reservado para o contêiner. Quando a memória do sistema estiver em contenção, o Docker tentará manter a memória do contêiner dentro desse limite flexível. Entrentanto, seu contêiner pode usar mais memória quando necessário. O contêiner pode consumir até o limite rígido especificado pelo parâmetro memory (se aplicável), ou toda a memória disponível na instância de contêiner, o que ocorrer primeiro. Esse parâmetro é mapeado para MemoryReservation no comando create-container do docker na opção --memory-reservation de execução do docker.

Se um valor de memória no nível de tarefa não for especificado, será necessário especificar um número inteiro diferente de zero para um ou ambos memory ou memoryReservation em uma definição de contêiner. Caso você especifique ambos, memory deve ser maior que memoryReservation. Caso você especifique memoryReservation, o valor é subtraído dos recursos de memória disponíveis para a instância de contêiner na qual o contêiner está colocado. Caso contrário, o valor de memory é usado.

Por exemplo, suponha que seu contêiner normalmente use 128 MiB de memória, mas às vezes chegue a 256 MiB de memória por períodos curtos. É possível definir um memoryReservation de 128 MiB e um limite rígido de memory de 300 MiB. Essa configuração permite que contêiner reservasse apenas 128 MiB de memória dos recursos restantes na instância de contêiner. Ao mesmo tempo, essa configuração também possibilita que o contêiner utilize mais recursos de memória quando necessário.

O daemon para Docker 20.10.0 ou versão posterior reserva no mínimo 6 MiB de memória para um contêiner. Por isso, não especifique menos de 6 MiB de memória para os seus contêineres.

O daemon para Docker 19.03.13-ce ou versão anterior reserva no mínimo 4 MiB de memória para um contêiner. Por isso, não especifique menos de 4 MiB de memória para os seus contêineres.

Tipo: Matriz de objeto

Obrigatório: Não

Os mapeamentos de portas expõem as portas de rede do seu contêiner ao mundo externo. Isso permite que os clientes acessem sua aplicação. Também é usado para comunicação entre contêineres dentro da mesma tarefa.

Para definições de tarefas (tanto do tipo de inicialização do Fargate quanto do EC2) que usam o modo de rede awsvpc, especifique apenas a containerPort. A hostPort é sempre ignorada e a porta do contêiner é automaticamente mapeada para uma porta aleatória de alto número no host.

Os mapeamentos de porta no Windows usam o endereço de gateway NetNAT, e não o localhost. Não há loopback para mapeamentos de porta no Windows, de modo que você não pode acessar a porta mapeada de um contêiner no próprio host.

A maioria dos campos desse parâmetro (incluindo containerPort, hostPort, protocol) é mapeada para PortBindings no comando create-container do docker e a opção --publish de execução do docker. Caso o modo de rede de uma definição de tarefa seja definido como host, as portas host devem ser indefinidas ou corresponder à porta de contêiner no mapeamento de porta.

Caso você esteja especificando uma porta host, use a seguinte sintaxe:

"portMappings": [
    {
        "containerPort": integer,
        "hostPort": integer
    }
    ...
]

Caso você queira uma porta host atribuída automaticamente, use a seguinte sintaxe:

"portMappings": [
    {
        "containerPort": integer
    }
    ...
]

Tipo: objeto RepositoryCredentials

Obrigatório: Não

As credenciais do repositório para autenticação de registro privado.

Para ter mais informações, consulte Uso de imagens de contêiner que não são da AWS no Amazon ECS.

A política de reinicialização do contêiner e os parâmetros de configuração associados. Quando você configura uma política de reinicialização para um contêiner, o Amazon ECS pode reiniciar o contêiner sem precisar substituir a tarefa. Para ter mais informações, consulte Reiniciar contêineres individuais em tarefas do Amazon ECS com políticas de reinicialização de contêineres.

O comando da verificação de integridade de contêiner e os parâmetros de configuração associados para o contêiner. Para ter mais informações, consulte Como determinar a integridade das tarefas do Amazon ECS usando verificações de integridade de contêineres.

Tipo: número inteiro

Obrigatório: Não

O número de unidades de cpu que o agente de contêiner do Amazon ECS reservará para o contêiner. No Linux, esse parâmetro é mapeado como CpuShares na seção Criar um contêiner.

Este campo é opcional para tarefas que usam o tipo de inicialização do Fargate. A quantidade total de CPU reservada para todos os contêineres dentro da tarefa deve ser menor que o valor cpu de nível da tarefa.

Os contêineres de Linux compartilham unidades de CPU não alocadas com outros contêineres na instância de contêiner que tem a mesma proporção que a respectiva quantidade alocada. Por exemplo, suponha que você execute uma tarefa de contêiner único em um tipo de instância de núcleo único com 512 unidades de CPU especificadas para esse contêiner. Além disso, essa tarefa é a única em execução na instância de contêiner. Nesse exemplo, o contêiner pode utilizar o compartilhamento total de 1.024 unidades de CPU a qualquer momento. Porém, suponha que você tenha iniciado outra cópia da mesma tarefa nessa instância de contêiner. Cada tarefa tem garantido um mínimo de 512 unidades de CPU quando necessário. Da mesma forma, se o outro contêiner não estiver usando a CPU restante, cada contêiner poderá flutuar para o uso maior da CPU. Porém, se ambas as tarefas estiverem 100% ativas o tempo todo, elas ficarão limitadas a 512 unidades de CPU.

Nas instâncias de contêiner de Linux, o daemon do Docker na instância de contêiner usa o valor de CPU para calcular as proporções de compartilhamento de CPU para contêineres em execução. O valor de compartilhamento de CPU mínimo válido permitido pelo kernel do Linux é 2 e o valor de compartilhamento de CPU máximo válido permitido pelo kernel do Linux é 262144. No entanto, o parâmetro de CPU não é necessário, e é possível usar valores de CPU abaixo de dois e superior a 262144 em suas definições de contêiner. Para valores de CPU abaixo de dois (inclusive nulo) e acima de 262144, o comportamento varia com base na versão do agente de contêiner do Amazon ECS:

Nas instâncias de contêiner de Windows, a cota de CPU é imposta como uma cota absoluta. Os contêineres de Windows só têm acesso à quantidade de CPU especificada na definição de tarefa. Um valor de CPU nulo ou zero é transmitido para Docker como 0. Em seguida, Windows interpreta esse valor como 1% de uma CPU.

Para obter exemplos adicionais, consulte Como o Amazon ECS gerencia recursos de CPU e memória.

Tipo: objeto ResourceRequirement

Obrigatório: Não

O número de GPUs físicas que o agente de contêiner do Amazon ECS reservará para o contêiner. O número de GPUs reservadas para todos os contêineres em uma tarefa não deve exceder o número de GPUs disponíveis na instância de contêiner na qual a tarefa é executada. Para ter mais informações, consulte Definições de tarefa do Amazon ECS para workloads de GPU.

Tipo: objeto ResourceRequirement

Obrigatório: Não

Para o tipo InferenceAccelerator, o value corresponde ao deviceName para um InferenceAccelerator especificado em uma definição de tarefa. Para ter mais informações, consulte Nome do acelerador de inferência elástica.

Tipo: booliano

Obrigatório: Não

Suponha que o parâmetro essential de um contêiner esteja marcado como true, e que esse contêiner falhe ou seja interrompido por algum motivo. Em seguida, todos os outros contêineres que fazem parte da tarefa são interrompidos. Caso o parâmetro essential de um contêiner esteja marcado como false, a falha não afeta o restante dos contêineres em uma tarefa. Caso esse parâmetro seja omitido, um contêiner pressupõe-se que um contêiner seja essencial.

Todas as tarefas devem ter pelo menos um contêiner essencial. Suponha que você tenha uma aplicação composta por vários contêineres. Em seguida, agrupe os contêineres usados para uma finalidade em comum em componentes e separe os componentes diferentes em várias definições de tarefa. Para ter mais informações, consulte Projetar sua aplicação para o Amazon ECS.

"essential": true|false

Tipo: Matriz de strings

Obrigatório: Não

O ponto de entrada passado para o contêiner.

"entryPoint": ["string", ...]

Tipo: Matriz de strings

Obrigatório: Não

O comando que é passado para o contêiner. Esse parâmetro é mapeado para Cmd no comando create-container e o parâmetro COMMAND de execução do docker. Se houver vários argumentos, certifique-se de que cada um seja uma string separada na matriz.

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

Tipo: string

Obrigatório: Não

O diretório de trabalho no qual executar comandos no contêiner. Esse parâmetro é mapeado para WorkingDir na seção Criar um contêiner da Docker Remote API e a opção --workdir para docker run.

"workingDirectory": "string"

Tipo: Matriz de objeto

Obrigatório: Não

Uma lista de arquivos que contêm as variáveis de ambiente a serem passadas para um contêiner. Esse parâmetro é mapeado para a opção --env-file para o comando run do docker.

Quando o FIPS é habilitado em um host usando o tipo de inicialização do EC2, nomes de bucket com pontos (.) (por exemplo, amzn-s3-demo-bucket1.name.example) não são compatíveis. Ter pontos (.) no nome do bucket impede que a tarefa seja iniciada porque o agente não consegue extrair o arquivo da variável de ambiente do Amazon S3.

Isso não está disponível para contêineres do Windows e contêineres do Windows no Fargate.

É possível especificar até 10 arquivos de ambiente. O arquivo deve ter uma extensão .env. Cada linha em um arquivo de ambiente contém uma variável de ambiente no formato VARIABLE=VALUE. As linhas que começam com # são tratadas como comentários e são ignoradas.

Se houver variáveis de ambiente individuais especificadas na definição de contêiner, elas terão precedência sobre as variáveis contidas em um arquivo de ambiente. Se forem especificados vários arquivos de ambiente que contenham a mesma variável, elas serão processadas de cima para baixo. Recomendamos usar nomes de variáveis exclusivos. Para ter mais informações, consulte Transferência de uma variável de ambiente individual para um contêiner do Amazon ECS.

Tipo: Matriz de objeto

Obrigatório: Não

As variáveis de ambiente a serem passadas para um contêiner. Esse parâmetro é mapeado para Env no comando create-container do docker na opção --env para o comando run do docker.

"environment" : [
    { "name" : "string", "value" : "string" },
    { "name" : "string", "value" : "string" }
]

Tipo: Matriz de objeto

Obrigatório: Não

Um objeto que representa o segredo a ser exposto ao seu contêiner. Para ter mais informações, consulte Transferência de dados confidenciais para um contêiner do Amazon ECS.

"secrets": [
    {
        "name": "environment_variable_name",
        "valueFrom": "arn:aws:ssm:region:aws_account_id:parameter/parameter_name"
    }
]

Tipo: booliano

Obrigatório: Não

Quando esse parâmetro é verdadeiro, a rede é desativada dentro do contêiner.

O padrão é false.

"disableNetworking": true|false

Tipo: Matriz de strings

Obrigatório: Não

O parâmetro link permite que os contêineres se comuniquem entre si sem a necessidade de mapeamentos de porta. Só há suporte para esse parâmetro se o modo de rede de uma definição de tarefa estiver definido como bridge. O construto name:internalName é igual ao name:alias em links do Docker. São permitidos até 255 letras (caixa alta e baixa), números, hífens e sublinhados.

"links": ["name:internalName", ...]

Tipo: string

Obrigatório: Não

O nome de host a ser usado para o contêiner. Esse parâmetro é mapeado para Hostname em create-container do docker na opção --hostname de execução do docker.

"hostname": "string"

Tipo: Matriz de strings

Obrigatório: Não

Uma lista de servidores DNS apresentados ao contêiner.

"dnsServers": ["string", ...]

Tipo: Matriz de strings

Obrigatório: Não

Padrão: ^[a-zA-Z0-9-.]{0,253}[a-zA-Z0-9]$

Uma lista de domínios de pesquisa DNS apresentados ao contêiner. Esse parâmetro é mapeado para DnsSearch no comando create-container do docker na opção --dns-search de execução do docker.

"dnsSearchDomains": ["string", ...]

Tipo: Matriz de objeto

Obrigatório: Não

Uma lista de nomes de host e mapeamentos de endereço IP a ser acrescentada ao arquivo /etc/hosts no contêiner.

Esse parâmetro é mapeado para ExtraHosts no comando create-container do docker na opção --add-host de execução do docker.

"extraHosts": [
      {
        "hostname": "string",
        "ipAddress": "string"
      }
      ...
    ]

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 no comando create-container do docker na opção --read-only de execução do docker.

O padrão é false.

"readonlyRootFilesystem": true|false

Tipo: Matriz de objeto

Obrigatório: Não

Os pontos de montagem dos volumes de dados no contêiner. Esse parâmetro é mapeado em Volumes na API create-container do Docker na opção --volume de execução do docker.

Os contêineres do Windows podem montar diretórios inteiros na mesma unidade como $env:ProgramData. Os contêineres do Windows não podem montar diretórios em uma unidade diferente, e os pontos de montagem não podem ser usados ​​entre unidades. Você deve especificar pontos de montagem para anexar um volume do Amazon EBS diretamente a uma tarefa do Amazon ECS.

Tipo: Matriz de objeto

Obrigatório: Não

Volumes de dados a serem montados de outro contêiner. Esse parâmetro é mapeado para VolumesFrom no comando create-container do docker na opção --volumes-from de execução do docker.

"volumesFrom": [
                {
                  "sourceContainer": "string",
                  "readOnly": true|false
                }
              ]

Tipo: objeto LogConfiguration

Obrigatório: Não

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

Para obter definições de tarefa de exemplo que usam uma configuração de log, consulte Exemplos de definições de tarefa do Amazon ECS.

Esse parâmetro é mapeado para LogConfig no comando create-container do docker na opção --log-driver de execução do docker. Por padrão, os contêineres usam o mesmo driver de registro em log que o daemon do Docker usa. No entanto, o contêiner pode usar um driver de registro em log 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 em log diferente para um contêiner, o sistema de log deve ser configurado corretamente na instância de contêiner (ou em um servidor de log diferente para opções de registro em log remotas).

Considere o seguinte ao especificar uma configuração de log para seus contêineres:

"logConfiguration": {
      "logDriver": "awslogs","fluentd","gelf","json-file","journald","logentries","splunk","syslog","awsfirelens",
      "options": {"string": "string"
        ...},
	"secretOptions": [{
		"name": "string",
		"valueFrom": "string"
	}]
}

Tipe: objeto FirelensConfiguration

Obrigatório: Não

A configuração do FireLens para o contêiner. Isso é usado para especificar e configurar um roteador de log para logs de contêiner. Para ter mais informações, consulte Envio de logs do Amazon ECS para um serviço da AWS ou para uma AWS Partner.

{
    "firelensConfiguration": {
        "type": "fluentd",
        "options": {
            "KeyName": ""
        }
    }
}

Tipo: Matriz de strings

Obrigatório: Não

Uma lista de ARNs no SSM ou no Amazon S3 para um arquivo de especificação de credencial (CredSpec) que configura o contêiner para autenticação do Active Directory. Recomendamos o uso deste parâmetro, em vez de dockerSecurityOptions. O número máximo de ARNs é 1.

Há dois formatos para cada ARN.

Em ambos os formatos, substitua MyARN pelo ARN no SSM ou no Amazon S3.

A credspec deve fornecer um ARN no Secrets Manager para um segredo contendo o nome de usuário, a senha e o domínio ao qual se conectar. Para maior segurança, a instância não é associada ao domínio para autenticação sem domínio. Outras aplicações na instância não podem usar as credenciais sem domínio. É possível usar esse parâmetro para executar tarefas na mesma instância, mesmo que as tarefas precisem ser associadas a domínios diferentes. Para obter mais informações, consulte Uso de gMSAs para contêineres de Windows e Uso de gMSAs para contêineres de Linux.

Tipo: booliano

Obrigatório: Não

Quando esse parâmetro é verdadeiro, o contêiner recebe privilégios elevados na instância de contêiner host (semelhante ao usuário root). Não recomendamos operar contêineres com privileged. Na maioria dos casos, é possível especificar os privilégios exatos necessários usando os parâmetros específicos em vez de privileged.

Esse parâmetro é mapeado para Privileged no comando create-container do docker na opção --privileged de execução do docker.

O padrão é false.

"privileged": true|false

Tipo: string

Obrigatório: Não

O usuário a ser utilizado dentro do contêiner. Esse parâmetro é mapeado para User no comando create-container do docker na opção --user de execução do docker.

É possível especificar o user usando os formatos a seguir. Se especificar um UID ou um GID, você deverá especificá-lo como um número inteiro positivo.

"user": "string"

Tipo: matriz de strings

Valores válidos: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"

Obrigatório: Não

Uma lista de strings para fornecer configuração personalizada para vários sistemas de segurança. Esse campo não é válido para contêineres em tarefas usando o tipo de inicialização Fargate.

Para tarefas de Linux no EC2, esse parâmetro pode ser usado para referenciar rótulos personalizados para sistemas de segurança de vários níveis SELinux e AppArmor .

Para quaisquer tarefas no EC2, este parâmetro pode ser usado para fazer referência a um arquivo de especificação de credenciais que configura um contêiner para autenticação do Active Directory. Para ter mais informações, consulte Saiba como usar gMSAs para contêineres do Windows do Amazon EC2 para o Amazon ECS e Usar gMSA para contêineres do Linux do EC2 no Amazon ECS.

Esse parâmetro é mapeado para SecurityOpt no comando create-container do docker na opção --security-opt de execução do docker.

"dockerSecurityOptions": ["string", ...]

Tipo: Matriz de objeto

Obrigatório: Não

Lista de valores ulimit a serem definidos para um contêiner. Esse valor substitui a configuração de cota de recursos padrão do sistema operacional. Esse parâmetro é mapeado para Ulimits no comando create-container do docker na opção --ulimit de execução do docker.

As tarefas do Amazon ECS hospedadas no Fargate usam os valores de limite de recursos padrão limitados pelo sistema operacional, com exceção do parâmetro de limite de recursos nofile. O limite de recursos nofile define uma restrição sobre o número de arquivos abertos que um contêiner pode usar. No Fargate, o limite flexível padrão de nofile é 65535, e o limite rígido é 65535. É possível definir os valores de ambos os limites até 1048576. Para ter mais informações, consulte Limites de recursos de tarefa.

Este parâmetro requer a versão 1.18 da Docker Remote API ou posterior em sua instância de contêiner.

"ulimits": [
      {
        "name": "core"|"cpu"|"data"|"fsize"|"locks"|"memlock"|"msgqueue"|"nice"|"nofile"|"nproc"|"rss"|"rtprio"|"rttime"|"sigpending"|"stack",
        "softLimit": integer,
        "hardLimit": integer
      }
      ...
    ]

Tipo: mapa de string para string

Obrigatório: Não

Um mapa de chave/valor de rótulos a ser adicionado ao contêiner. Esse parâmetro é mapeado para Labels no comando create-container do docker na opção --label de execuçã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.

"dockerLabels": {"string": "string"
      ...}

Tipo: Objeto LinuxParameters

Obrigatório: Não

Opções específicas do Linux que são aplicadas ao contêiner, como KernelCapabilities.

"linuxParameters": {
      "capabilities": {
        "add": ["string", ...],
        "drop": ["string", ...]
        }
      }

Tipo: matriz de objetos ContainerDependency

Obrigatório: Não

As dependências definidas para startup e desligamento do contêiner. Um contêiner pode conter várias dependências. Quando uma dependência é definida para o startup do contêiner, ela é revertida para o desligamento do contêiner. Para ver um exemplo, consulte Dependência de contêiner.

Para tarefas do Amazon ECS hospedadas em instâncias do Amazon EC2, as instâncias exigem pelo menos a versão 1.26.0 do agente do contêiner para habilitar dependências de contêiner. No entanto, recomendamos usar a versão mais recente do agente de contêiner. Para obter informações sobre como verificar a versão do agente e atualizar para a versão mais recente, consulte Atualizar o agente de contêiner do Amazon ECS. Se você estiver usando uma AMI do Amazon Linux otimizada para o Amazon ECS, sua instância precisará pelo menos da versão 1.26.0-1 do pacote ecs-init. Se as instâncias de contêiner são executadas na versão 20190301 ou posterior, então elas contêm as versões necessárias do agente de contêiner e do ecs-init. Para ter mais informações, consulte AMIs do Linux otimizadas para o Amazon ECS.

Para tarefas do Amazon ECS hospedadas no Fargate, este parâmetro exige que a tarefa ou o serviço use a versão da plataforma 1.3.0 ou posterior (Linux), ou 1.0.0 (Windows).

"dependsOn": [
    {
        "containerName": "string",
        "condition": "string"
    }
]

Tipo: número inteiro

Obrigatório: Não

Valores de exemplo: 120

Tempo a ser aguardado (em segundos) antes de desistir de resolver dependências para um contêiner.

Por exemplo, você especifica dois contêineres em uma definição de tarefa com o containerA tendo uma dependência do containerB atingir um status COMPLETE, SUCCESS ou HEALTHY. Se um valor de startTimeout for especificado para o containerB e ele não atingir o status desejado nesse tempo, o containerA não será iniciado.

Para tarefas do Amazon ECS hospedadas no Fargate, esse parâmetro exige que a tarefa ou o serviço use a versão da plataforma 1.3.0 ou posterior (Linux). O valor máximo é 120 segundos.

Tipo: número inteiro

Obrigatório: Não

Valores de exemplo: 120

Período (em segundos) a ser aguardado antes de o contêiner ser eliminado de maneira forçada se não for encerrado normalmente por conta própria.

Para tarefas do Amazon ECS hospedadas no Fargate, esse parâmetro exige que a tarefa ou o serviço use a versão da plataforma 1.3.0 ou posterior (Linux). Se o parâmetro não for especificado, então o valor padrão de 30 segundos será usado. O valor máximo para o Fargate é 120 segundos.

Para tarefas que usam o tipo de execução do EC2, se o parâmetro stopTimeout não for especificado, o valor definido para a variável de configuração do agente do contêiner do Amazon ECS ECS_CONTAINER_STOP_TIMEOUT será usado. Se nem o parâmetro stopTimeout nem a variável de configuração do agente ECS_CONTAINER_STOP_TIMEOUT forem definidos, serão usados os valores padrão de 30 segundos para contêineres de Linux e 30 segundos para contêineres de Windows. As instâncias de contêiner exigem pelo menos a versão 1.26.0 do agente de contêiner para habilitar um valor de tempo limite de interrupção de contêiner. No entanto, recomendamos usar a versão mais recente do agente de contêiner. Para obter informações sobre como verificar a versão do agente e atualizar para a versão mais recente, consulte Atualizar o agente de contêiner do Amazon ECS. Se você estiver usando a AMI do Amazon Linux otimizada para o Amazon ECS, sua instância precisará pelo menos da versão 1.26.0-1 do pacote ecs-init. Se as instâncias de contêiner são executadas na versão 20190301 ou posterior, então elas contêm as versões necessárias do agente de contêiner e do ecs-init. Para ter mais informações, consulte AMIs do Linux otimizadas para o Amazon ECS.

Tipo: objeto SystemControl

Obrigatório: Não

Uma lista de parâmetros de kernel com namespace a ser definida no contêiner. Esse parâmetro é mapeado para Sysctls no comando create-container do docker e na opção --sysctl de execução do docker. Por exemplo, é possível definir a configuração net.ipv4.tcp_keepalive_time para manter conexões de longa duração.

Não recomendamos que você especifique parâmetros systemControls relacionados à rede para vários contêineres em uma única tarefa que também use o modo de rede awsvpc ou host. Fazer isso apresenta as desvantagens a seguir:

Se você estiver configurando um namespace de recurso IPC para usar nos contêineres da tarefa, as condições a seguir serão aplicadas aos controles do sistema. Para ter mais informações, consulte Modo IPC.

"systemControls": [
    {
         "namespace":"string",
         "value":"string"
    }
]

Tipo: booliano

Obrigatório: Não

Quando esse parâmetro é true, você pode implantar aplicações em contêineres que exigem a alocação de stdin ou tty. Esse parâmetro é mapeado para OpenStdin no comando create-container do docker na opção --interactive de execução do docker.

O padrão é false.

Tipo: booliano

Obrigatório: Não

Quando esse parâmetro é true, um TTY é alocado. Esse parâmetro é mapeado para Tty no comando create-container do docker na opção --tty de execução do docker.

O padrão é false.

Tipo: string

Obrigatório: Sim

O nome do dispositivo do acelerador de inferência elástica. O deviceName também deve ser referenciado em uma definição de contêiner, consulte Elastic Inference accelerator.

Tipo: string

Obrigatório: Sim

O acelerador de inferência elástica a ser usado.

Tipo: string

Obrigatório: Não

Uma expressão de idioma de consulta de cluster a ser aplicada à restrição. Para ter mais informações, consulte Criação de expressões para definir instâncias de contêiner em tarefas do Amazon ECS.

Tipo: string

Obrigatório: Sim

O tipo de restrição. Use memberOf para restringir a seleção a um grupo de candidatos válidos.

Tipo: objeto ProxyConfiguration

Obrigatório: Não

Os detalhes de configuração do proxy do App Mesh.

Para as tarefas que usam o tipo de execução do EC2, as instâncias de contêiner exigem pelo menos a versão 1.26.0 do agente de contêiner e pelo menos a versão 1.26.0-1 do pacote ecs-init para habilitar uma configuração de proxy. Se as instâncias de contêiner forem executadas na AMI otimizada para o Amazon ECS versão 20190301 ou posterior, elas conterão as versões necessárias do agente de contêiner e do ecs-init. Para ter mais informações, consulte AMIs do Linux otimizadas para o Amazon ECS.

Para tarefas que usam o tipo de inicialização do Fargate, esse recurso exige que a tarefa ou o serviço use a versão 1.3.0 ou posterior da plataforma.

"proxyConfiguration": {
    "type": "APPMESH",
    "containerName": "string",
    "properties": [
        {
           "name": "string",
           "value": "string"
        }
    ]
}

Tipo: string

Obrigatório: Não

O nome do volume. São permitidos até 255 letras (caixa alta e baixa), números, hífens (-) e sublinhados (_). Esse nome é referenciado no parâmetro sourceVolume do objeto mountPoints de definição do contêiner.

Obrigatório: Não

O parâmetro host é usado para vincular o ciclo de vida da montagem bind à instância host do Amazon EC2, em vez da tarefa, e onde ela está armazenada. Caso o parâmetro host esteja vazio, o daemon do Docker atribui um caminho host para o volume de dados, mas os dados não têm garantia de persistir depois que os contêineres associados deixarem de ser executados.

Os contêineres do Windows podem montar diretórios inteiros na mesma unidade como $env:ProgramData.

Tipo: booliano

Obrigatório: Não

Especifica se um volume é configurável na execução. Quando definido como true, você pode configurar o volume ao executar uma tarefa autônoma ou ao criar ou atualizar um serviço. Quando definido como true, não será possível fornecer outra configuração de volume na definição da tarefa. Esse parâmetro deve ser definido como true para configurar um volume do Amazon EBS para anexação a uma tarefa. Definir configuredAtLaunch como true e adiar a configuração do volume para a fase de execução permite criar definições de tarefas que não estão restritas a um tipo de volume ou a configurações de volume específicas. Isso torna a definição de tarefa reutilizável em diferentes ambientes de execução. Para obter mais informações, consulte Volumes do Amazon EBS.

Tipo: objeto DockerVolumeConfiguration

Obrigatório: Não

Esse parâmetro é especificado ao usar volumes do Docker. Os volumes do Docker só são compatíveis ao executar tarefas em instâncias do EC2. Os contêineres do Windows só são compatíveis com o uso do driver local. Para usar montagens bind, em vez disso, especifique um host.

Tipo: objeto EFSVolumeConfiguration

Obrigatório: Não

Esse parâmetro é especificado quando volumes Amazon EFS são usados.

Tipo: objeto FSxWindowsFileServerVolumeConfiguration

Obrigatório: Sim

Esse parâmetro é especificado quando você está usando um sistema de arquivos do Amazon FSx para Windows File Server para armazenamento de tarefas.

Tipo: string

Obrigatório: Não

Uma parte de um par de chave/valor que compõe uma tag. Uma chave é um rótulo geral que age como uma categoria para valores de tag mais específicos.

Tipo: string

Obrigatório: Não

A parte opcional de um par de chave/valor que compõe uma tag. Um valor atua como um descritor dentro de uma categoria de tag (chave).

Tipo: objeto EphemeralStorage

Obrigatório: Não

A quantidade de armazenamento temporário (em GB) a ser alocado para a tarefa. Esse parâmetro é usado para expandir a quantidade total de armazenamento temporário, além da quantidade padrão, para tarefas hospedadas no AWS Fargate. Para ter mais informações, consulte Uso de montagens vinculadas com o Amazon ECS.

Tipo: string

Obrigatório: Não

O namespace de recurso IPC a ser usado para os contêineres na tarefa. Os valores válidos são host, task ou none. Se o host for especificado, todos os contêineres dentro das tarefas que especificaram o modo IPC host na mesma instância de contêiner compartilham os mesmos recursos IPC com a instância do Amazon EC2 do host. Se task for especificado, todos os contêineres dentro da tarefa especificada compartilharão os mesmos recursos IPC. Se none for especificado, os recursos IPC nos contêineres de uma tarefa serão privados e não serão compartilhados com outros contêineres em uma tarefa ou na instância de contêiner. Se nenhum valor for especificado, o compartilhamento do namespace de recurso IPC dependerá da configuração do daemon do Docker na instância de contêiner.

Se o modo IPC host for usado, haverá um risco elevado de exposição indesejada do namespace IPC.

Se você estiver definindo parâmetros de kernel com namespace que usa systemControls para os contêineres na tarefa, os itens a seguir serão aplicados ao seu namespace de recurso IPC.

Tipo: string

Valores válidos: host | task

Obrigatório: Não

O namespace do processo a ser usado para os contêineres na tarefa. Os valores válidos são host ou task. Nos contêineres Fargate para Linux, o único valor válido é task. Por exemplo, o monitoramento de arquivos associados pode precisar que pidMode acesse informações sobre outros contêineres em execução na mesma tarefa.

Se o host for especificado, todos os contêineres das tarefas que especificaram o modo PID host na mesma instância de contêiner compartilharão namespace de processo com a instância do Amazon EC2 do host.

Se a task for especificada, todos os contêineres da tarefa especificada compartilharão o mesmo namespace de processo.

Se nenhum valor for especificado, o padrão será um namespace privado para cada contêiner.

Se o modo PID host for usado, haverá um risco elevado de exposição indesejada do namespace de processo.