# Parâmetros de definição de serviço do Amazon ECS
Uma definição de serviço define como executar o serviço do .Amazon ECS. É possível especificar os parâmetros a seguir em uma definição de serviço.
## Tipo de inicialização
`launchType`
Tipo: string
Valores válidos: `EC2` \$1 `FARGATE` \$1 `EXTERNAL`
Obrigatório: não
O tipo de inicialização na qual executar seu serviço. Se não for especificado um tipo de inicialização, o padrão `capacityProviderStrategy` será usado.
Quando você atualiza um serviço, esse parâmetro aciona uma nova implantação de serviço.
Se um `launchType` for especificado, o parâmetro `capacityProviderStrategy` deverá ser omitido.
## Estratégia de provedor de capacidade
`capacityProviderStrategy`
Tipo: matriz de objetos
Obrigatório: não
A estratégia de provedor de capacidade a ser usada para o serviço.
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
Uma estratégia de provedor de capacidade consiste em um ou mais provedores de capacidade junto com o `base` e o `weight` a serem atribuídos a eles. Um provedor de capacidade deve ser associado ao cluster a ser usado em uma estratégia de provedor de capacidade. A API PutClusterCapacityProviders é usada para associar um provedor de capacidade a um cluster. Somente provedores de capacidade com um status `ACTIVE` ou `UPDATING` podem ser usados.
Se um `capacityProviderStrategy` for especificado, o parâmetro `launchType` deverá ser omitido. Se nenhum `capacityProviderStrategy` ou `launchType` for especificado, o `defaultCapacityProviderStrategy` do cluster será usado.
Se quiser especificar um provedor de capacidade que use um grupo do Auto Scaling, o provedor de capacidade já deverá estar criado. Novos provedores de capacidade podem ser criados com a operação de API CreateCapacityProvider.
Para usar um provedor de capacidade do AWS Fargate, especifique os provedores de capacidade `FARGATE` ou `FARGATE_SPOT`. Os provedores de capacidade do AWS Fargate estão disponíveis para todas as contas e só precisam estar associados a um cluster para serem utilizados.
A operação de API PutClusterCapacityProviders é usada para atualizar a lista de provedores de capacidade disponíveis para um cluster após a criação do cluster.
`capacityProvider`
Tipo: String
Exigido: sim
O nome abreviado ou o Nome de recurso da Amazon (ARN) completo do provedor de capacidade.
`weight`
Tipo: inteiro
Intervalo válido: inteiros entre 0 e 1.000.
Obrigatório: não
O valor do peso designa a porcentagem relativa do número total de tarefas executadas que usam o provedor de capacidade especificado.
Por exemplo, imagine que você tenha uma estratégia contendo dois provedores de capacidade e ambos têm um peso de um. Quando a base é atendida, as tarefas se dividem igualmente entre os dois provedores de capacidade. Com base nessa mesma lógica, imagine que você especifique um peso de 1 para *capacityProviderA* e um peso de 4 para *capacityProviderB*. Em seguida, para cada tarefa executada utilizando *capacityProviderA*, quatro tarefas utilizam *capacityProviderB*.
`base`
Tipo: inteiro
Intervalo válido: inteiros entre 0 e 100.000.
Obrigatório: não
O valor base designa o número mínimo de tarefas que serão executadas no provedor de capacidade especificado. Somente um provedor de capacidade em uma estratégia de provedor de capacidade pode ter uma base definida.
## definição da tarefa
`taskDefinition`
Tipo: string
Obrigatório: não
O `family` e `revision` (`family:revision`) ou o nome do recurso da Amazon (ARN) completo da definição de tarefa a ser executada no serviço. Se um `revision` não for especificado, a última revisão `ACTIVE` da família especificada será usada.
Quando você atualiza um serviço, esse parâmetro aciona uma nova implantação de serviço.
É necessário especificar uma definição de tarefa ao usar o controlador de implantação (`ECS`) de atualização contínua.
## Sistema operacional da plataforma
`platformFamily`
Tipo: string
Obrigatório: Condicional
Padrão: Linux
Esse parâmetro é necessário para serviços do Amazon ECS hospedados no Fargate.
Esse parâmetro é ignorado para serviços do Amazon ECS hospedados no Amazon EC2.
O sistema operacional nos contêineres que executa o serviço. Os valores válidos são `LINUX`, `WINDOWS_SERVER_2019_FULL`, `WINDOWS_SERVER_2019_CORE`, `WINDOWS_SERVER_2022_FULL` e `WINDOWS_SERVER_2022_CORE`.
O valor `platformFamily` para cada tarefa especificada para o serviço deve corresponder ao valor `platformFamily` do serviço. Por exemplo, se você definir a `platformFamily` como `WINDOWS_SERVER_2019_FULL`, o valor de `platformFamily` para todas as tarefas deve ser `WINDOWS_SERVER_2019_FULL`.
## Versão da plataforma
`platformVersion`
Tipo: string
Obrigatório: não
A versão da plataforma na qual suas tarefas no serviço estão em execução. Uma versão da plataforma é especificada apenas para tarefas que usam o tipo de inicialização do Fargate. Se não for especificada, a versão mais recente (`LATEST`) será usada como padrão.
Quando você atualiza um serviço, esse parâmetro aciona uma nova implantação de serviço.
As versões da plataforma do AWS Fargate são usadas para fazer referência a um ambiente de runtime específico para a infraestrutura de tarefas do Fargate. Ao especificar a versão da plataforma `LATEST` quando estiver executando uma tarefa ou criando um serviço, você obtém a versão de plataforma mais atual disponível para suas tarefas. Ao escalar seu serviço, essas tarefas recebem a versão de plataforma especificada na implantação atual do serviço. Para obter mais informações, consulte [Versões da plataforma do Fargate para o Amazon ECS](platform-fargate.md).
Versões de plataforma não são especificadas para tarefas que usam o tipo de inicialização do EC2.
## Cluster
`cluster`
Tipo: string
Obrigatório: não
O nome abreviado ou o Nome de recurso da Amazon (ARN) completo do cluster no qual executar o serviço. Se você não especificar um cluster, consideraremos o cluster `default`.
## Nome do serviço
`serviceName`
Tipo: String
Exigido: sim
O nome do serviço. São permitidos até 255 letras (caixa alta e baixa), números, hífens e sublinhados. Os nomes dos serviços devem ser exclusivos em um cluster, mas é possível ter serviços com nomes semelhantes em vários clusters em uma ou várias regiões.
## Estratégia de programação
`schedulingStrategy`
Tipo: string
Valores válidos: `REPLICA` \$1 `DAEMON`
Obrigatório: não
A estratégia de programação para usar. Se nenhuma estratégia de agendamento for especificada, será usada a estratégia `REPLICA`. Para obter mais informações, consulte [Serviços do Amazon ECS](ecs_services.md).
Há duas estratégias de programador de serviços disponíveis:
+ `REPLICA`: a estratégia de programação de réplica coloca e mantém o número desejado de tarefas no seu cluster. Por padrão, o programador de serviço distribui tarefas por zonas de disponibilidade. É possível usar estratégias e limitações de posicionamento de tarefas para personalizar decisões de posicionamento de tarefa. Para obter mais informações, consulte [Estratégia de agendamento de réplicas](ecs_service-options.md#service_scheduler_replica).
+ `DAEMON`: a estratégia de programação do daemon implanta exatamente uma tarefa em cada instância de contêiner ativa que atenda a todas as restrições de posicionamento de tarefas que você especifica no seu cluster. Ao usar essa estratégia, não há necessidade de especificar um número desejado de tarefas, uma estratégia de posicionamento de tarefas ou usar políticas de Auto Scaling do serviço. Para obter mais informações, consulte [Estratégia de agendamento de daemon](ecs_service-options.md#service_scheduler_daemon).
**nota**
As tarefas do Fargate não são compatíveis com a estratégia de programação do `DAEMON`.
## Contagem desejada
`desiredCount`
Tipo: inteiro
Obrigatório: não
O número de instanciações da definição de tarefa específica a posicionar e manter em execução no seu serviço.
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
Esse parâmetro será necessário se a estratégia de agendamento `REPLICA` for usada. Se o serviço usar a estratégia de agendamento `DAEMON`, esse parâmetro será opcional.
Quando você usa o ajuste de escala automático do serviço, ao atualizar um serviço que está em execução e que tem um `desiredCount` menor do que o número de tarefas em execução no momento, o serviço é reduzido para o `desiredCount` especificado.
## Configuração de implantação
`deploymentConfiguration`
Tipo: Objeto
Obrigatório: não
Parâmetros opcionais de implantação que controlam quantas tarefas são executadas durante a implantação e o pedido de encerramento e iniciação de tarefas.
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
`maximumPercent`
Tipo: inteiro
Obrigatório: não
Se um serviço estiver usando o tipo de implantação de atualização contínua (`ECS`), o parâmetro `maximumPercent` representará um limite superior no número de tarefas do serviço que são permitidas no estado `RUNNING`, `STOPPING` ou `PENDING` durante a implantação. Ele é expresso como uma porcentagem do `desiredCount` arredondado para o número inteiro mais próximo. É possível usar esse parâmetro para definir o tamanho do lote de implantação. Por exemplo, se o serviço estiver usando o agendador de serviços `REPLICA` e tiver uma `desiredCount` de quatro tarefas e um valor `maximumPercent` de 200%, o agendador iniciará quatro novas tarefas antes de interromper as quatro tarefas mais antigas. Isso é fornecido desde que os recursos de cluster necessários para isso estejam disponíveis. O valor padrão `maximumPercent` para um serviço que usa o programador de serviço `REPLICA` é 200%.
O agendador do Amazon ECS usa esse parâmetro para substituir tarefas não íntegras iniciando primeiro as tarefas de substituição e depois interrompendo as tarefas não íntegras, desde que os recursos do cluster para iniciar as tarefas de substituição estejam disponíveis. Para obter mais informações sobre como o agendador substitui tarefas não íntegras, consulte [Serviços do Amazon ECS](ecs_services.md).
Se o seu serviço estiver usando o tipo de programador de serviços `DAEMON`, `maximumPercent` deverá permanecer em 100%. Este é o valor padrão.
O número máximo de tarefas durante uma implantação é `desiredCount` multiplicado por `maximumPercent`/100, arredondado para o valor inteiro mais próximo.
Se um serviço estiver usando o tipo de implantação azul/verde (`CODE_DEPLOY`) ou tipos de implantação `EXTERNAL` e as tarefas que usam o tipo de inicialização do EC2, os valores de **porcentagem máxima** serão definidos para os valores padrão. Eles são usados para definir os limites superiores do número de tarefas no serviço que permanecem no estado `RUNNING` enquanto as instâncias de contêiner estão no estado `DRAINING`.
Você não pode especificar um valor `maximumPercent` personalizado para um serviço que usa o tipo de implantação azul/verde (`CODE_DEPLOY`) ou `EXTERNAL` e tem tarefas que usam o EC2.
Se o serviço utilizar o tipo de implantação azul/verde (`CODE_DEPLOY`) ou `EXTERNAL`, e as tarefas do serviço utilizarem o Fargate, o valor da porcentagem máxima não será utilizado. O valor ainda é retornado ao descrever seu serviço.
`minimumHealthyPercent`
Tipo: inteiro
Obrigatório: não
Se um serviço estiver usando o tipo de implantação de atualização contínua (`ECS`), `minimumHealthyPercent` representará um limite inferior no número de tarefas do serviço que devem permanecer no `RUNNING` ou durante a implantação. Isso é expresso como uma porcentagem de `desiredCount`, arredondada para cima até o número inteiro mais próximo. É possível usar esse parâmetro para implantar sem usar capacidade adicional de cluster.
Por exemplo, se o serviço tiver um `desiredCount` de quatro tarefas, um `minimumHealthyPercent` de 50% e um `maximumPercent` de 100%, o agendador de serviços interromperá duas tarefas existentes para liberar a capacidade do cluster antes de iniciar duas novas tarefas.
Se alguma tarefa não estiver íntegra e `maximumPercent` não permitir que o agendador do Amazon ECS inicie tarefas de substituição, o agendador interromperá as tarefas não íntegras uma a uma usando `minimumHealthyPercent` como uma restrição para liberar capacidade para iniciar tarefas de substituição. Para obter mais informações sobre como o agendador substitui tarefas não íntegras, consulte [Serviços do Amazon ECS](ecs_services.md).
Para serviços que *não* usam um balanceador de carga, considere o seguinte:
+ Um serviço será considerado íntegro se todos os contêineres essenciais dentro das tarefas no serviço forem aprovados em suas verificações de integridade.
+ Se uma tarefa não tiver contêineres essenciais com uma verificação de integridade definida, o programador de serviço aguardará 40 segundos depois que uma tarefa atingir um estado `RUNNING` antes de a tarefa ser contabilizada no percentual mínimo íntegro total.
+ Se uma tarefa tiver um ou mais contêineres essenciais com uma verificação de integridade definida, o programador de serviço aguardará que a tarefa atinja um status íntegro antes de a contabilizar no percentual mínimo íntegro total. Uma tarefa é considerada íntegra quando todos os contêineres essenciais dentro da tarefa são aprovados em suas verificações de integridade. O período de tempo que o programador de serviço pode aguardar é determinado pelas configurações de verificação de integridade do contêiner. Para obter mais informações, consulte [Verificação de integridade](task_definition_parameters.md#container_definition_healthcheck).
Para serviços que *usam* um balanceador de carga, considere o seguinte:
+ Se uma tarefa não tiver contêineres essenciais com uma verificação de integridade definida, o programador de serviço aguardará a verificação de integridade do grupo de destino do balanceador de carga retornar um status íntegro antes de contabilizar a tarefa no percentual mínimo íntegro total.
+ Se uma tarefa tiver um contêiner essencial com uma verificação de integridade definida, o programador de serviço aguardará que a tarefa atinja um status íntegro e a verificação de integridade do grupo de destino do balanceador de carga retorne um status íntegro antes de contabilizar a tarefa no percentual mínimo íntegro total.
O valor padrão para um serviço réplica para `minimumHealthyPercent` é 100%. O valor padrão `minimumHealthyPercent` para um serviço que usa o programador de serviço `DAEMON` é 0% para a AWS CLI, os AWS SDKs e as APIs, e 50% para o Console de gerenciamento da AWS.
O número mínimo de tarefas íntegras durante uma implantação é `desiredCount` multiplicado por `minimumHealthyPercent`/100, arredondado para o valor inteiro mais próximo acima.
Se um serviço estiver usando o tipo de implantação azul/verde (`CODE_DEPLOY`) ou `EXTERNAL` e executando tarefas que usam o EC2, o valor de **porcentagem de integridade mínima** será definido com o valor padrão. Eles são usados para definir os limites inferiores do número de tarefas no serviço que permanecem no estado `RUNNING` enquanto as instâncias de contêiner estão no estado `DRAINING`.
Você não pode especificar um valor `maximumPercent` personalizado para um serviço que usa o tipo de implantação azul/verde (`CODE_DEPLOY`) ou `EXTERNAL` e tem tarefas que usam o EC2.
Se um serviço estiver usando o tipo de implantação azul/verde (`CODE_DEPLOY`) ou `EXTERNAL` e estiver executando tarefas que usam o Fargate, o valor percentual mínimo de integridade não será usado, embora ele seja retornado ao descrever o serviço.
## Controlador de implantação
`deploymentController`
Tipo: Objeto
Obrigatório: não
O controlador de implantação a ser usado para o serviço. Se nenhum controlador de implantação for especificado, será usado o controlador `ECS`. Para obter mais informações, consulte [Serviços do Amazon ECS](ecs_services.md).
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
`type`
Tipo: string
Valores válidos: `ECS` \$1 `CODE_DEPLOY` \$1 `EXTERNAL`
Obrigatório: sim
O tipo de controlador de implantação a ser usado. Existem três tipos de controlador de implantação disponíveis:
`ECS`
O controlador de implantação do Amazon ECS oferece suporte a várias estratégias de implantação: atualização incremental, azul/verde, linear e canário. O tipo de implantação de atualização incremental envolve substituir a versão atual em execução do contêiner pela versão mais recente. As implantações azul/verde criam um novo ambiente e transferem o tráfego de uma só vez. As implantações lineares mudam gradualmente o tráfego em incrementos percentuais iguais. As implantações canário transferem primeiro uma pequena porcentagem do tráfego e depois transferem o restante. O número de contêineres que o Amazon ECS adiciona ou remove do serviço durante uma atualização contínua é controlado ajustando-se os números mínimo e máximo de tarefas íntegras permitidas durante uma implantação de serviço, conforme especificado na [deploymentConfiguration](#deploymentConfiguration).
`CODE_DEPLOY`
O tipo de implantação azul/verde (`CODE_DEPLOY`) usa o modelo de implantação azul/verde desenvolvido pelo CodeDeploy, que permite que você verifique a nova implantação de um serviço antes de enviar tráfego de produção para ele.
`EXTERNAL`
Use o tipo de implantação externa quando desejar usar qualquer controlador de implantação de terceiros para o controle total do processo de implantação para um serviço do Amazon ECS.
## Posicionamento de tarefas
`placementConstraints`
Tipo: matriz de objetos
Obrigatório: não
Um array de objetos de restrição de posicionamento para usar em tarefas no serviço. É possível especificar no máximo 10 restrições por tarefa. Esse limite inclui restrições na definição de tarefa e aquelas especificadas no runtime. Se você utiliza o Fargate, não há suporte para restrições de posicionamento de tarefa.
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
`type`
Tipo: string
Obrigatório: não
O tipo de restrição. Use `distinctInstance` para garantir que cada tarefa em um determinado grupo esteja em execução em uma instância de contêiner diferente. Use `memberOf` para restringir a seleção a um grupo de candidatos válidos. O valor `distinctInstance` não é compatível em definições de tarefa.
`expression`
Tipo: string
Obrigatório: não
Uma expressão de idioma de consulta de cluster a ser aplicada à restrição. Você não pode especificar uma expressão, caso o tipo de restrição seja `distinctInstance`. Para obter mais informações, consulte [Criação de expressões para definir instâncias de contêiner em tarefas do Amazon ECS](cluster-query-language.md).
`placementStrategy`
Tipo: matriz de objetos
Obrigatório: não
A estratégia de posicionamento de objetos para usar em tarefas no serviço. É possível especificar um máximo de quatro regras de estratégia por serviço.
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
`type`
Tipo: string
Valores válidos: `random` \$1 `spread` \$1 `binpack`
Obrigatório: não
O tipo de estratégia de posicionamento. A estratégia de posicionamento `random` posiciona as tarefas de candidatos disponíveis aleatoriamente. A estratégia de posicionamento `spread` distribui o posicionamento entre os candidatos disponíveis uniformemente com base no parâmetro do `field`. A estratégia `binpack` posiciona as tarefas em candidatos disponíveis que tenham a menor quantia disponível do recurso que está especificado no parâmetro `field`. Por exemplo, se você efetuar binpack na memória, uma tarefa será posicionada na instância com a menor quantidade de memória remanescente (mas ainda o suficiente para executar a tarefa).
`field`
Tipo: string
Obrigatório: não
O campo em que a estratégia de posicionamento será aplicada. Para a estratégia de posicionamento `spread`, os valores válidos são `instanceId` (ou `host`, que tem o mesmo efeito), ou qualquer atributo de plataforma ou personalizado que seja aplicado em uma instância de contêiner, como `attribute:ecs.availability-zone`. Para a estratégia de posicionamento `binpack`, os valores válidos são `cpu` e `memory`. Para a estratégia de posicionamento `random`, esse campo não é usado.
## Tags
`tags`
Tipo: matriz de objetos
Obrigatório: não
Os metadados que você aplica ao serviço para ajudá-lo a categorizá-los e organizá-los. Cada tag consiste de uma chave e um valor opcional, que podem ser definidos. Quando um serviço é excluído, as tags também são excluídas. Um máximo de 50 tags podem ser aplicadas ao serviço. Para obter mais informações, consulte [Marcação de recursos do Amazon ECS](ecs-using-tags.md).
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
`key`
Tipo: string
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 128.
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.
`value`
Tipo: string
Restrições de tamanho: o tamanho mínimo é 0. O comprimento máximo é 256.
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).
`enableECSManagedTags`
Tipo: booliano
Valores válidos: `true` \$1 `false`
Obrigatório: não
Especifica se devem ser usadas as tags gerenciadas do Amazon ECS para as tarefas no serviço. Se nenhum valor for especificado, o padrão será `false`. Para obter mais informações, consulte [Usar etiquetas para faturamento](ecs-using-tags.md#tag-resources-for-billing).
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
`propagateTags`
Tipo: string
Valores válidos: `TASK_DEFINITION` \$1 `SERVICE`
Obrigatório: não
Especifica se deve copiar as tags da definição de tarefa ou do serviço para as tarefas no serviço. Se nenhum valor for especificado, as tags não serão copiadas. As tags só podem ser copiadas para tarefas no serviço durante a criação do serviço. Para adicionar etiquetas a uma tarefa após a criação do serviço ou da tarefa, use a ação de API `TagResource`.
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
## Configuração de rede
`networkConfiguration`
Tipo: Objeto
Obrigatório: não
A configuração de rede para o serviço. Esse parâmetro é necessário para definições de tarefa que usam o modo de rede `awsvpc` para receber sua própria Interface de rede elástica e não tem suporte para outros modos de rede. Se estiver usando o Fargate, será necessário o modo de rede `awsvpc`. Para obter mais informações sobre redes no EC2, consulte [Opções da rede de tarefas do Amazon ECS para o EC2](task-networking.md). Para obter mais informações sobre redes no Fargate, consulte [Opções de rede de tarefas do Amazon ECS para o Fargate](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html).
Quando você atualiza um serviço, esse parâmetro aciona uma nova implantação de serviço.
`awsvpcConfiguration`
Tipo: Objeto
Obrigatório: não
Um objeto que representa as sub-redes e os security groups de uma tarefa ou serviço.
`subnets`
Tipo: matriz de strings
Obrigatório: Sim
As sub-redes associadas à tarefa ou ao serviço. Existe um limite de 16 sub-redes que podem ser especificadas de acordo com `awsvpcConfiguration`.
`securityGroups`
Tipo: matriz de strings
Obrigatório: Não
Os security groups associados à tarefa ou ao serviço. Se você não especificar um grupo de segurança, o grupo de segurança padrão da VPC será usado. Existe um limite de cinco grupos de segurança que podem ser especificados com base em `awsvpcConfiguration`.
`assignPublicIP`
Tipo: string
Valores válidos: `ENABLED` \$1 `DISABLED`
Obrigatório: não
Indica se a interface de rede elástica da tarefa recebe um endereço IP público. Se nenhum valor for especificado, será usado o valor padrão de `DISABLED`.
`healthCheckGracePeriodSeconds`
Tipo: inteiro
Obrigatório: não
O período, em segundos, durante o qual o programador de serviço do Amazon ECS ignora verificações de integridade não íntegras de Elastic Load Balancing, VPC Lattice e contêiner depois que uma tarefa é iniciada pela primeira vez. Se você não especificar um valor de período de tolerância de verificação de integridade, o valor padrão 0 será usado. Se você não usar nenhuma das verificações de integridade, então `healthCheckGracePeriodSeconds` não será utilizado.
Se as tarefas do serviço demorarem para iniciar e responder, você poderá especificar um período de carência para a verificação de integridade de até 2.147.483.647 segundos (cerca de 69 anos). Durante esse tempo, o programador de serviço do Amazon ECS Service ignorará o status das verificações de integridade. Esse período de carência pode evitar que o programador do serviço marque tarefas como não íntegras e as interrompa antes de terem tempo de surgir.
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
`loadBalancers`
Tipo: matriz de objetos
Obrigatório: não
Um objeto load balancer que representa os load balancers para uso com o serviço. Para serviços que usam um Application Load Balancer ou um Network Load Balancer, existe um limite de cinco grupos de destino que você pode anexar a um serviço.
Quando você atualiza um serviço, esse parâmetro aciona uma nova implantação de serviço.
Após você criar um serviço, a configuração do balanceador de carga não poderá ser alterada no Console de gerenciamento da AWS. É possível usar o AWS Copilot, o AWS CloudFormation, a AWS CLI ou o SDK para modificar a configuração do balanceador de carga somente para o controlador de implantação rolling do `ECS`, e não o AWS CodeDeploy azul/verde ou externo. Quando você adiciona, atualiza ou remove uma configuração de balanceador de carga, o Amazon ECS inicia uma nova implantação com a configuração atualizada do Elastic Load Balancing. Isso faz com que as tarefas se registrem e cancelem o registro dos balanceadores de carga. Recomendamos verificar isso em um ambiente de teste antes de atualizar a configuração do Elastic Load Balancing. Para obter informações sobre como modificar a configuração, consulte [UpdateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html) na *Referência da API do Amazon Elastic Container Service*.
Para Application Load Balancers e Network Load Balancers, esse objeto deve conter o ARN do grupo de destino do balanceador de carga, o nome do contêiner (conforme aparece em uma definição de contêiner) e a porta do contêiner para acesso a partir do balanceador de carga. Quando uma tarefa desse serviço é colocada em uma instância do contêiner, combinação da instância do contêiner e a porta é registrada como um destino no grupo de destino especificado.
`targetGroupArn`
Tipo: string
Obrigatório: não
O nome do recurso da Amazon (ARN) completo do grupo de destino do Elastic Load Balancing associado a um serviço.
O ARN de um grupo de destino só é especificado ao usar um Application Load Balancer ou um Network Load Balancer.
`loadBalancerName`
Tipo: string
Obrigatório: não
O nome do load balancer que deve ser associado ao serviço.
Se estiver usando um Application Load Balancer ou um Network Load Balancer, omita o parâmetro de nome do balanceador de carga.
`containerName`
Tipo: string
Obrigatório: não
O nome do contêiner (conforme aparece na definição de contêiner) para associar ao balanceador de carga.
`containerPort`
Tipo: inteiro
Obrigatório: não
A porta no contêiner para associar ao balanceador de carga. Essa porta deve corresponder a um `containerPort` na definição de tarefa usada pelas tarefas do serviço. Para tarefas que usam o EC2, a instância de contêiner deve permitir tráfego de entrada no `hostPort` do mapeamento de porta.
`role`
Tipo: string
Obrigatório: não
O nome curto ou o ARN completo da função do IAM que permite que o Amazon ECS faça chamadas para o balanceador de carga em seu nome. Esse parâmetro só será permitido se você estiver usando um balanceador de carga com um único grupo de destino para o serviço e a definição de tarefa não usar o modo de rede `awsvpc`. Se você especificar o parâmetro `role`, você também deve especificar um objeto do load balancer com o parâmetro `loadBalancers`.
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
Se a função especificada tiver um caminho diferente de `/`, você deverá especificar a função completa de Nome de região da Amazon (ARN), isso é recomendado, ou prefixar o nome da função com o caminho. Por exemplo, se uma função com o nome `bar` tiver um caminho `/foo/`, você especificaria `/foo/bar` como o nome da função. Para obter mais informações, consulte [Nome e caminhos amigáveis](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) no *Guia do usuário do IAM*.
Se sua conta já tiver criado a função vinculada ao serviço do Amazon ECS, essa função será usada por padrão para o serviço, a menos que você especifique uma função aqui. A função vinculada ao serviço será necessária se a definição de sua tarefa usar o modo de rede awsvpc e, nesse caso, você não deve especificar uma função aqui. Para obter mais informações, consulte [Uso de perfis vinculados ao serviço para o Amazon ECS](using-service-linked-roles.md).
`serviceConnectConfiguration`
Tipo: Objeto
Obrigatório: não
A configuração desse serviço para detectar e se conectar a serviços e para ser detectado por outros serviços e ser conectado a eles em um namespace.
Quando você atualiza um serviço, esse parâmetro aciona uma nova implantação de serviço.
Para obter mais informações, consulte [Uso do Service Connect para conectar serviços do Amazon ECS com nomes abreviados](service-connect.md).
`enabled`
Tipo: booliano
Obrigatório: Sim
Especifica se o Service Connect deverá ser usado com esse serviço.
`namespace`
Tipo: string
Obrigatório: não
O nome do recurso da Amazon (ARN) abreviado ou completo do namespace AWS Cloud Map para uso com o Service Connect. O namespace deve estar na mesma Região da AWS que o serviço e o cluster do Amazon ECS. O tipo de namespace não afeta o Service Connect. Para obter mais informações sobre o AWS Cloud Map, consulte [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) (Trabalhar com serviços) no *Guia do desenvolvedor do AWS Cloud Map*.
`services`
Tipo: matriz de objetos
Obrigatório: não
Uma matriz de objetos de serviço do Service Connect. Estes são os nomes e aliases (também conhecidos como endpoints) que são usados por outros serviços do Amazon ECS para se conectar a esse serviço.
Este campo não é obrigatório para um serviço “cliente” do Amazon ECS que seja membro de um namespace somente para se conectar a outros serviços dentro do namespace. Um exemplo é a aplicação de frontend que aceita solicitações recebidas de um balanceador de carga conectado ao serviço ou por outros meios.
Um objeto seleciona uma porta na definição da tarefa, atribui um nome para o serviço do AWS Cloud Map e uma matriz de aliases (também conhecidos como endpoints) e portas para que as aplicações clientes se refiram a esse serviço.
`portName`
Tipo: String
Exigido: sim
O `portName` deve corresponder ao `name` de um dos `portMappings` de todos os contêineres na definição de tarefa desse serviço do Amazon ECS.
`discoveryName`
Tipo: string
Obrigatório: não
O `discoveryName` é o nome do novo serviço do AWS Cloud Map que o Amazon ECS cria para esse serviço do Amazon ECS. Esse nome deve ser exclusivo no namespace do AWS Cloud Map.
Se esse campo não for especificado, será usado `portName`.
`clientAliases`
Tipo: matriz de objetos
Obrigatório: não
A lista de aliases de cliente para esse serviço de conexão de serviços. Você os usa para atribuir nomes que podem ser usados por aplicações clientes. O número máximo de aliases de cliente que você pode ter nesta lista é 1.
Cada alias (“endpoint”) é um nome DNS e um número de porta que outros serviços (“clientes”) do Amazon ECS podem usar para se conectar a esse serviço.
Cada nome e cada combinação de porta deve ser exclusivo dentro do namespace.
Esses nomes são configurados em cada tarefa do serviço de cliente, não no AWS Cloud Map. As solicitações DNS para resolver esses nomes não saem da tarefa e não contam para a cota de solicitações DNS por segundo por interface de rede elástica.
`port`
Tipo: inteiro
Obrigatório: Sim
O número da porta receptora para o proxy de conexão de serviços. Essa porta está disponível em todas as tarefas dentro do mesmo namespace.
Para evitar a alteração das suas aplicações nos serviços do cliente Amazon ECS, defina isso como a mesma porta que a aplicação cliente usa por padrão.
`dnsName`
Tipo: string
Obrigatório: não
O `dnsName` é o nome que você usa nas aplicações das tarefas do cliente para se conectar a esse serviço. O nome deve ser um rótulo DNS válido.
O valor padrão será o `discoveryName.namespace` se esse campo não for especificado. Se a `discoveryName` não for especificada, será usada a `portName` da definição de tarefa.
Para evitar a alteração das suas aplicações nos serviços do cliente Amazon ECS, defina isso como o mesmo nome que a aplicação cliente usa por padrão. Por exemplo, alguns nomes comuns são `database`, `db` ou o nome em minúsculas de um banco de dados, como `mysql` ou `redis`.
`ingressPortOverride`
Tipo: inteiro
Obrigatório: não
(Opcional) O número da porta para o proxy do Service Connect receber.
Use o valor desse campo para ignorar o proxy para tráfego no número da porta especificado na `portMapping` nomeada na definição de tarefa dessa aplicação e, em seguida, use-o em seus grupos de segurança da Amazon VPC para permitir tráfego para o proxy para esse serviço do Amazon ECS.
No modo `awsvpc`, o valor padrão é o número da porta do contêiner especificado no `portMapping` nomeado na definição de tarefa dessa aplicação. No modo `bridge`, o valor padrão é a porta temporária do proxy do Service Connect.
`logConfiguration`
Tipo: objeto [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html)
Obrigatório: não
Isso define o local em que os logs do proxy do Service Connect são publicados. Use os logs para depuração durante eventos inesperados. Essa configuração define o parâmetro `logConfiguration` no contêiner do proxy do Service Connect em cada tarefa nesse serviço do Amazon ECS. O contêiner do proxy não é especificado na definição de tarefa.
Recomendamos que você use a mesma configuração de log dos contêineres de aplicações da definição de tarefa para esse serviço do Amazon ECS. Para o FireLens, esta é a configuração de log do contêiner da aplicação. Não é o contêiner de roteador de log do FireLens que usa a imagem de contêiner `fluent-bit` ou `fluentd `.
`accessLogConfiguration`
Tipo: objeto [ServiceConnectAccessLogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html)
Obrigatório: não
A configuração do log de acesso do Service Connect, incluindo o formato do log e se é necessário ou não que os logs incluam cadeias de caracteres de consulta. Os logs de acesso capturam informações detalhadas sobre as solicitações feitas ao serviço, incluindo padrões de solicitação, código de resposta e dados de tempo. Para habilitar os logs de acesso, especifique também um `logConfiguration` no`serviceConnectConfiguration`.
`serviceRegistries`
Tipo: matriz de objetos
Obrigatório: não
Os detalhes da configuração de descoberta de serviço para o seu serviço. Para obter mais informações, consulte [Uso da descoberta de serviços para conectar serviços do Amazon ECS com nomes DNS](service-discovery.md).
Quando você atualiza um serviço, esse parâmetro aciona uma nova implantação de serviço.
`registryArn`
Tipo: string
Obrigatório: não
O nome do recurso da Amazon (ARN) do registro de serviço. O registro de serviço atualmente compatível é AWS Cloud Map. Para obter mais informações, consulte [Trabalhar com serviços](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) no *Guia do desenvolvedor do AWS Cloud Map*.
`port`
Tipo: inteiro
Obrigatório: não
O valor da porta usado se o serviço de descoberta de serviços especificou um registro de SRV. Esse campo é necessário se o modo de rede `awsvpc` e registros de SRV são usados.
`containerName`
Tipo: string
Obrigatório: não
O valor do nome do contêiner a ser usado para o serviço de descoberta de serviço. Esse valor é especificado na definição da tarefa. Se a definição de tarefa que sua tarefa de serviço especifica usa o modo de rede `bridge` ou `host` você deve especificar uma combinação de `containerName` e `containerPort` da definição de tarefa. Se a definição de tarefa que sua tarefa de serviço especifica usa o modo de rede `awsvpc` e um registro do tipo SRV DNS é usado, você deve especificar uma combinação de `containerName` e `containerPort` ou um valor `port`, mas não ambos.
`containerPort`
Tipo: inteiro
Obrigatório: não
O valor do porta a ser usado para o serviço de descoberta de serviço. Esse valor é especificado na definição da tarefa. Se a definição de tarefa que sua tarefa de serviço especifica usa o modo de rede `bridge` ou `host` você deve especificar uma combinação de `containerName` e `containerPort` da definição de tarefa. Se a definição de tarefa que sua tarefa de serviço especifica usa o modo de rede `awsvpc` e um registro do tipo SRV DNS é usado, você deve especificar uma combinação de `containerName` e `containerPort` ou um valor `port`, mas não ambos.
## Token de cliente
`clientToken`
Tipo: string
Obrigatório: não
O identificador exclusivo e que diferencia maiúsculas e minúsculas que você fornece para garantir a idempotência da solicitação. Pode ter até 32 caracteres ASCII.
## Rebalanceamento de zonas de disponibilidade
`availabilityZoneRebalancing`
Tipo: string
Obrigatório: não
Indica se o serviço usa rebalanceamento de zonas de disponibilidade. Os valores válidos são `ENABLED` e `DISABLED`.
Quando você atualiza um serviço, esse parâmetro não aciona uma nova implantação de serviço.
Comportamento padrão:
+ Para novos serviços: se nenhum valor for especificado, o padrão será `DISABLED`.
+ Para serviços existentes: se nenhum valor for especificado, o Amazon ECS padronizará o valor para o valor existente. Se nenhum valor foi definido anteriormente, o Amazon ECS define o valor como `DISABLED`.
Para ter mais informações sobre o rebalanceamento de zonas de disponibilidade, consulte [Balancear um serviço do Amazon ECS entre zonas de disponibilidade](service-rebalancing.md).
## Configurações de volume
`volumeConfigurations`
Tipo: Objeto
Obrigatório: não
A configuração que será usada para criar volumes de tarefas gerenciadas pelo serviço. Somente volumes marcados como `configuredAtLaunch` na definição de tarefa podem ser configurados usando esse objeto.
Quando você atualiza um serviço, esse parâmetro aciona uma nova implantação de serviço.
Esse objeto é necessário para associar volumes do Amazon EBS a tarefas gerenciadas por um serviço. Para obter mais informações, consulte [Uso de volumes do Amazon EBS com o Amazon ECS](ebs-volumes.md).
`name`
Tipo: String
Exigido: sim
O nome de um volume configurado ao criar ou atualizar um serviço. São permitidos até 255 letras (caixa alta e baixa), números, hifens (`_`) e sublinhados (`-`). Esse valor deve corresponder ao nome do volume especificado na definição de tarefa.
`managedEBSVolume`
Tipo: Objeto
Obrigatório: não
A configuração de volume usada para criar volumes do Amazon EBS que são associados a tarefas gerenciadas por um serviço quando o serviço é criado ou atualizado. Um volume é associado por tarefa.
`encrypted`
Tipo: booliano
Obrigatório: não
Valores válidos: `true`\$1`false`
Especifica se cada volume do Amazon EBS criado deve ser criptografado. Se você ativou a criptografia do Amazon EBS por padrão para uma Região da AWS específica para sua Conta da AWS, mas definiu esse parâmetro como `false`, esse parâmetro será substituído e os volumes serão criptografados com a chave do KMS especificada para criptografia por padrão. Para obter mais informações sobre criptografia do Amazon EBS por padrão, consulte [Habilitar criptografia do Amazon EBS por padrão](https://docs.aws.amazon.com/ebs/latest/userguide/encryption-by-default.html) no *Guia do usuário do Amazon EBS*. Para obter mais informações sobre a criptografia de volumes do Amazon EBS associados a tarefas do Amazon ECS, consulte [Criptografar dados armazenados em volumes do Amazon EBS para tarefas do Amazon ECS](ebs-kms-encryption.md).
`kmsKeyId`
Tipo: string
Obrigatório: não
O identificador da chave do AWS Key Management Service (AWS KMS) a ser usada para criptografia no Amazon EBS. Se `kmsKeyId` for especificado, o estado de criptografado deverá ser `true`.
A chave especificada usando esse parâmetro substitui o padrão do Amazon EBS ou qualquer chave do KMS em nível de cluster para a criptografia de armazenamento gerenciado do Amazon ECS que você possa ter especificado. Para obter mais informações, consulte [Criptografar dados armazenados em volumes do Amazon EBS para tarefas do Amazon ECS](ebs-kms-encryption.md).
Você pode especificar a chave do KMS usando qualquer um dos seguintes itens:
+ **ID da chave**: por exemplo, `1234abcd-12ab-34cd-56ef-1234567890ab`.
+ **Alias de chave**: por exemplo, `alias/ExampleAlias`.
+ **ARN de chave**: por exemplo, `arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab`.
+ **Alias de ARN**: por exemplo, `arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias`.
A AWS autentica a chave do KMS de forma assíncrona. Portanto, se você especificar um ID, um alias ou um ARN que não seja válido, a ação poderá parecer estar concluída, mas falhará. Para obter mais informações, consulte [Troubleshooting Amazon EBS volume attachment issues](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/troubleshoot-ebs-volumes.html).
`volumeType`
Tipo: string
Obrigatório: não
Valores válidos: `gp2`\$1`gp3`\$1`io1`\$1`io2`\$1`sc1`\$1`st1`\$1`standard`
O tipo de volume do Amazon EBS. Para obter mais informações sobre tipos de volumes, consulte [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) no *Guia do usuário do Amazon EBS*. O tipo de volume padrão é `gp3`.
O tipo de volume `standard` não é compatível com tarefas do Fargate.
`sizeInGiB`
Tipo: inteiro
Obrigatório: não
Intervalo válido: números inteiros entre 1 e 16.384
O tamanho do volume do EBS em gibibytes (GiB). Se você não fornecer um ID de snapshot para configurar um volume para anexação, deverá fornecer um valor de tamanho. Se você configurar um volume para anexação usando um snapshot, o valor padrão será o tamanho do snapshot. Em seguida, você pode especificar um tamanho maior ou igual ao tamanho do snapshot.
Para tipos de volume `gp2` e `gp3`, o intervalo válido é de 1 a 16.384.
Para tipos de volume `io1` e `io2`, o intervalo válido é de 4 a 16.384.
Para tipos de volume `st1` e `sc1`, o intervalo válido é de 125 a 16.384.
Para o tipo de volume `standard`, o intervalo válido é de 1 a 1.024.
`snapshotId`
Tipo: string
Obrigatório: não
O ID do snapshot de um volume do Amazon EBS existente usado pelo Amazon ECS para criar novos volumes para associação. Especifique um `snapshotId` ou um `sizeInGiB`.
`volumeInitializationRate`
Tipo: inteiro
Obrigatório: não
A taxa, em MiB/s, na qual os dados são recuperados em um snapshot de um volume do Amazon EBS existente para criar novos volumes para associação. Essa propriedade só poderá ser especificada se você especificar uma `snapshotId`. Para obter mais informações sobre essa taxa de inicialização de volume, incluindo a faixa de taxas compatíveis para inicialização, consulte [Inicializar volumes do Amazon EBS](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) no *Guia do usuário do Amazon EBS*.
`iops`
Tipo: inteiro
Obrigatório: não
O número de operações de E/S por segundo (IOPS). Para volumes de `gp3`, `io1` e `io2`, isso representa o número de IOPS provisionadas para o volume. Em volumes do `gp2`, esse valor representa o desempenho de linha de base do volume e a taxa na a qual o volume acumula créditos de E/S para intermitência. Esse parâmetro é necessário para volumes `io1` e `io2`. Esse parâmetro não é compatível com volumes `gp2`, `st1`, `sc1` ou `standard`.
Para volumes `gp3`, o intervalo válido de valores é de 3.000 a 16.000.
Para volumes `io1`, o intervalo válido de valores é de 100 a 64.000.
Para volumes `io2`, o intervalo válido de valores é de 100 a 64.000.
`throughput`
Tipo: inteiro
Obrigatório: não
O throughput para provisionamento dos volumes associados a tarefas gerenciadas por um serviço.
Esse parâmetro é compatível apenas com volumes do `gp3`.
`roleArn`
Tipo: String
Exigido: sim
O recurso da Amazon (ARN) do perfil do AWS Identity and Access Management (IAM) da infraestrutura que fornece permissões do Amazon ECS para gerenciar recursos do Amazon EBS nas tarefas. Para obter mais informações, consulte [Perfil do IAM de infraestrutura do Amazon ECS](infrastructure_IAM_role.md).
`tagSpecifications`
Tipo: Objeto
Obrigatório: não
A especificação das tags a serem aplicadas a cada volume do Amazon EBS.
`resourceType`
Tipo: String
Exigido: sim
Valores válidos: `volume`
O tipo de recurso a ser marcado na criação.
`tags`
Tipo: matriz de objetos
Obrigatório: não
Os metadados que você aplica aos volumes para ajudar a categorizá-los e organizá-los. Cada tag consiste em uma chave e um valor opcional, ambos definidos por você. `AmazonECSCreated` e `AmazonECSManaged` são tags reservadas adicionadas pelo Amazon ECS em seu nome para que você possa especificar no máximo 48 tags de sua preferência. Quando um volume é excluído, as tags também são excluídas. Para obter mais informações, consulte [Marcação de recursos do Amazon ECS](ecs-using-tags.md).
`key`
Tipo: String
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 128.
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.
`value`
Tipo: string
Restrições de tamanho: o tamanho mínimo é 0. O comprimento máximo é 256.
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).
`propagateTags`
Tipo: string
Valores válidos: `TASK_DEFINITION` \$1 `SERVICE` \$1 `NONE`
Obrigatório: não
Especifica se as tags da definição de tarefa ou do serviço devem ser copiadas para um volume. Se `NONE` for especificado ou nenhum valor for especificado, as tags não serão copiadas.
`fileSystemType`
Tipo: string
Obrigatório: não
Valores válidos: `xfs`\$1`ext3`\$1`ext4`\$1`NTFS`
O tipo de sistema de arquivos em um volume. O tipo de sistema de arquivos do volume determina como os dados são armazenados e recuperados no volume. Em volumes criados de um snapshot, você deve especificar o mesmo tipo de sistema de arquivos que o volume estava usando quando o snapshot foi criado. Se houver uma incompatibilidade no tipo do sistema de arquivos, a tarefa não será iniciada.
Os valores válidos para o Linux são `xfs`, ext3`, and ext4`. O padrão para volumes anexados às tarefas do Linux é `XFS`.
Os valores válidos para o Windows são `NTFS`. O padrão para volumes anexados a tarefas do Windows é `NTFS`.