Parámetros de definición de tareas de Amazon ECS

Tipo: cadena

Obligatorio: sí

Cuando se registra una definición de tarea, se le da una familia, que es similar a un nombre para varias versiones de la definición de tarea, especificado con un número de revisión. A la primera definición de tareas que se registra en una familia particular se le da una revisión de 1 y a cualquier definición de tarea registrada después se le da un número de revisión secuencial.

Tipo: matriz de cadenas

Requerido: no

Valores válidos: EC2 | FARGATE | EXTERNAL

Los tipos de lanzamiento con respecto a los cuales se validó la definición de tareas. Esto inicia una comprobación para garantizar que todos los parámetros utilizados en la definición de tareas cumplan los requisitos del tipo de lanzamiento.

Tipo: cadena

Requerido: no

Cuando se registra una definición de tareas, se puede proporcionar un rol de tarea para un rol de IAM que permita a los contenedores del permiso de tareas llamar en su nombre a las API de AWS especificadas en sus políticas asociadas. Para obtener más información, consulte Rol de IAM de tarea de Amazon ECS.

Al lanzar la AMI de Windows Server optimizada para Amazon ECS, los roles de IAM para las tareas de Windows requieren que se haya establecido la opción -EnableTaskIAMRole. Los contenedores deben ejecutar también código de configuración para utilizar la característica. Para obtener más información, consulte Configuración adicional de las instancias de Amazon EC2 de Windows.

Tipo: cadena

Obligatorio: condicional

El nombre de recurso de Amazon (ARN) del rol de ejecución de tarea que concede permiso al agente de contenedor de Amazon ECS para realizar llamadas a la API de AWS en su nombre.

Tipo: cadena

Requerido: no

El modo de red de Docker que utilizar para los contenedores en la tarea. Para las tareas de Amazon ECS que están alojadas en instancias de Linux de Amazon EC2, los valores válidos son none, bridge, awsvpc y host. Si no se especifica ningún modo de red, el modo de red predeterminado es bridge. Para las tareas de Amazon ECS alojadas en instancias de Windows de Amazon EC2, los valores válidos son default y awsvpc. Si no se especifica ningún modo de red, se utiliza el modo de red default. Para las tareas de Amazon ECS alojadas en Fargate, se requiere el modo de red awsvpc.

Si el modo de red se establece en none, los contenedores de tarea no tienen conectividad externa y no es posible especificar la asignación de puertos en la definición del contenedor.

Si el modo de red es bridge, la tarea usa la red virtual integrada de Docker en Linux, la cual se ejecuta dentro de cada instancia de Amazon EC2 que aloja la tarea. La red virtual integrada en Linux usa el controlador de red bridge Docker.

Si el modo de red es host, la tarea usa la red del host que omite la red virtual integrada de Docker al asignar los puertos del contenedor directamente a la ENI de la instancia de Amazon EC2 que aloja la tarea. Las asignaciones de puertos dinámicas no se pueden usar en este modo de red. Un contenedor de una definición de tarea que use este modo debe especificar un número de hostPort específico. Varias tareas no pueden usar el número de puerto de un host. Por lo tanto, no se pueden ejecutar varias tareas de la misma definición de tarea en una instancia de Amazon EC2 única.

Para los tipos de lanzamiento de Amazon EC2, si el modo de red es awsvpc, a la tarea se le asigna una interfaz de red elástica y debe especificar NetworkConfiguration al crear un servicio o ejecutar una tarea con la definición de tarea. Para obtener más información, consulte Opciones de redes de tareas de Amazon ECS para el tipo de lanzamiento de EC2.

Si el modo de red es default, la tarea usa la red virtual integrada de Docker en Windows, la cual se ejecuta dentro de cada instancia de Amazon EC2 que aloja la tarea. La red virtual integrada en Windows usa el controlador de red nat Docker.

Para los tipos de lanzamiento de Fargate, cuando el modo de red es awsvpc, a la tarea se le asigna una interfaz de red elástica y debe especificar NetworkConfiguration al crear un servicio o ejecutar una tarea con la definición de tarea. Para más información, consulte Redes de tareas de Fargate. El modo de red awsvpc ofrece el rendimiento de redes más alto para contenedores dado que estos utilizan la pila de la red de Amazon EC2. Los puertos de contenedor expuestos se asignan directamente al puerto de interfaz de red elástica asociado. Por este motivo, no se pueden utilizar asignaciones de puerto de host dinámico.

Los modos de red host y awsvpc ofrecen el rendimiento de redes más alto para contenedores dado que estos utilizan la pila de la red de Amazon EC2. Con los modos de red host y awsvpc, los puertos de contenedor expuestos se asignan directamente al puerto de host correspondiente (para el modo de red host) o al puerto de interfaz de red elástica asociado (para el modo de red awsvpc). Por este motivo, no se pueden utilizar asignaciones de puerto de host dinámico.

Si se usa el tipo de lanzamiento Fargate, es necesario el modo de red awsvpc. Si se usa el tipo de lanzamiento EC2, el modo de red permitido depende del sistema operativo de la instancia EC2 subyacente. Si es Linux, se puede usar cualquier modo de red. Si es Windows, se pueden usar los modos default y awsvpc.

Tipo: cadena

Obligatorio: condicional

Predeterminado: LINUX

Este parámetro es necesario para las tareas de Amazon ECS que están alojadas en Fargate.

Cuando se registra una definición de tarea, especifica la familia de sistemas operativos.

Los valores válidos para las tareas de Amazon ECS que están alojadas en Fargate son LINUX, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2022_FULL y WINDOWS_SERVER_2022_CORE.

Los valores válidos para las tareas de Amazon ECS alojadas en EC2 son LINUX, WINDOWS_SERVER_2022_CORE, WINDOWS_SERVER_2022_FULL, WINDOWS_SERVER_2019_FULL y WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2016_FULL, WINDOWS_SERVER_2004_CORE y WINDOWS_SERVER_20H2_CORE.

Todas las definiciones de tareas que se utilizan en un servicio deben tener el mismo valor para este parámetro.

Cuando una definición de tarea forma parte de un servicio, este valor debe coincidir con el valor platformFamily de servicio.

Tipo: cadena

Obligatorio: condicional

Predeterminado: X86_64

Este parámetro es necesario para las tareas de Amazon ECS alojadas en Fargate. Si el parámetro se deja como null, el valor predeterminado se asigna automáticamente al iniciar una tarea alojada en Fargate.

Cuando se registra una definición de tarea, especifica la arquitectura de CPU. Los valores válidos son X86_64 y ARM64.

Todas las definiciones de tareas que se utilizan en un servicio deben tener el mismo valor para este parámetro.

Cuando tiene tareas Linux para el tipo de lanzamiento de Fargate o el tipo de lanzamiento de EC2, puede establecer el valor en ARM64. Para obtener más información, consulte Definiciones de tareas de Amazon ECS para cargas de trabajo de ARM de 64 bits.

Tipo: cadena

Obligatorio: condicional

El límite máximo de unidades de CPU que presentar para la tarea. Puede indicar los valores de la CPU en el archivo JSON como una cadena en unidades de CPU o CPU virtuales (vCPU). Por ejemplo, puede especificar un valor de CPU 1024 en unidades de CPU o 1 vCPU en vCPU. Cuando se registra la definición de tarea, el valor de una CPU virtual se convierte en un entero que indica las unidades de CPU.

Para las tareas que se ejecutan en instancias externas o de EC2, este campo es opcional. Si el clúster no tiene registradas instancias de contenedor con las unidades de CPU solicitadas disponibles, la tarea no funciona. Los valores admitidos para las tareas que se ejecutan en instancias de EC2 o instancias externas se encuentran entre vCPU 0.125 y vCPU 10.

Para las tareas que se ejecutan en Fargate (tanto contenedores de Linux como de Windows), este campo es obligatorio y debe utilizar uno de los siguientes valores, lo que determina el intervalo de valores válidos para el parámetro memory. En la siguiente tabla se muestran las combinaciones válidas de CPU y memoria de nivel de tarea.

Tipo: cadena

Obligatorio: condicional

El límite máximo de memoria para presentar a la tarea. Puede especificar los valores de memoria en la definición de tareas como una cadena en mebibytes (MiB) o gigabytes (GB). Por ejemplo, puede especificar un valor de memoria 3072 en MiB o 3 GB en GB. Cuando se registra la definición de tarea, el valor de GB se convierte en un entero que indica el número de MiB.

Para las tareas que están alojadas en instancias de Amazon EC2, este campo es opcional y se puede usar cualquier valor. Si se especifica un valor de memoria de nivel de tarea, el valor de memoria de nivel de contenedor es opcional. Si el clúster no tiene registradas instancias de contenedor con la memoria solicitada disponible, la tarea no funciona. Puede maximizar la utilización de los recursos proporcionando a las tareas la mayor cantidad de memoria posible para un tipo de instancia determinado. Para obtener más información, consulte Reserva de la memoria de instancias de contenedor de Linux de Amazon ECS.

Para las tareas alojadas en Fargate (tanto contenedores de Linux como de Windows), este campo es obligatorio y debe utilizar uno de los siguientes valores, lo que determina el intervalo de valores válidos para el parámetro cpu:

Tipo: cadena

Obligatorio: sí

El nombre de un contenedor. Se admiten hasta 255 letras (mayúsculas y minúsculas), números, guiones y caracteres de subrayado. Si está vinculando varios contenedores en una definición de tareas, el name de un contenedor se puede introducir en los links de otro contenedor. Esto sirve para conectar los contenedores.

Tipo: cadena

Obligatorio: sí

La imagen que se utiliza para iniciar un contenedor. Esta cadena se transfiere directamente al daemon de Docker. De manera predeterminada, las imágenes del registro de Docker Hub están disponibles. También puede especificar otros repositorios con repository-url/image:tag o repository-url/image@digest. Se permiten hasta 255 letras (mayúsculas y minúsculas), números, guiones, caracteres de subrayado, comas, puntos, barras diagonales y signos numéricos. Este parámetro se corresponde con Image en el comando create-container de docker y el parámetro IMAGE del comando de docker run.

Tipo: entero

Requerido: no

La cantidad (en MiB) de memoria que se presenta al contenedor. Si su contenedor intenta superar la memoria especificada aquí, el contenedor se cancela. La cantidad total de memoria reservada para todos los contenedores dentro de una tarea debe ser menor que el valor memory de la tarea, si se especifica. Este parámetro se corresponde con Memory en el comando create-container de docker y la opción --memory se corresponde con docker run.

Si utiliza el tipo de lanzamiento de Fargate, este parámetro es opcional.

Si utiliza el tipo de lanzamiento de EC2, debe especificar un valor de memoria de nivel de tarea o un valor de memoria de nivel de contenedor. Si especifica un valor de memory y un valor de memoryReservation en el nivel de contenedor, el valor de memory debe ser mayor que el valor de memoryReservation. Si especifica memoryReservation, el valor se resta de los recursos de memoria disponibles para la instancia de contenedor en la que se coloca el contenedor. De lo contrario, se utiliza el valor de memory.

El daemon de Docker 20.10.0 o posterior reserva un mínimo de 6 MiB de memoria para un contenedor. Por lo tanto, no debe especificar menos de 6 MiB de memoria para los contenedores.

El daemon de Docker 19.03.13-ce o anterior reserva un mínimo de 4 MiB de memoria para un contenedor. Por lo tanto, no debe especificar menos de 4 MiB de memoria para los contenedores.

Tipo: entero

Requerido: no

El límite flexible (en MiB) de memoria que reservar para el contenedor. Cuando la memoria del sistema está en conflicto, Docker intenta mantener la memoria del contenedor en este límite flexible. Sin embargo, el contenedor puede utilizar más memoria cuando sea necesario. El contenedor puede utilizar hasta el límite invariable especificado con el parámetro de memory (si procede) o toda la memoria disponible en la instancia de contenedor, lo que ocurra primero. Este parámetro se corresponde con MemoryReservation en el comando create-container de docker y la opción --memory-reservation se corresponde con docker run.

Si no se especifica un valor de memoria de nivel de tarea, debe especificar un entero distinto de cero para memory o memoryReservation, o para ambos, en una definición de contenedor. Si especifica ambos, memory debe ser mayor que memoryReservation. Si especifica memoryReservation, el valor se resta de los recursos de memoria disponibles para la instancia de contenedor en la que se coloca el contenedor. De lo contrario, se utiliza el valor de memory.

Por ejemplo, supongamos que el contenedor utiliza normalmente 128 MiB de memoria, pero con ráfagas ocasionales de hasta 256 MiB durante períodos de tiempo breves. Puede establecer una memoryReservation de 128 MiB y un límite invariable de memory de 300 MiB. Esta configuración permite al contenedor reservar solo 128 MiB de memoria de los recursos restantes en la instancia de contenedor. Al mismo tiempo, esta configuración también permite que el contenedor consuma más recursos de memoria en caso de ser necesario.

El daemon de Docker 20.10.0 o posterior reserva un mínimo de 6 MiB de memoria para un contenedor. Por lo tanto, no debe especificar menos de 6 MiB de memoria para los contenedores.

El daemon de Docker 19.03.13-ce o anterior reserva un mínimo de 4 MiB de memoria para un contenedor. Por lo tanto, no debe especificar menos de 4 MiB de memoria para los contenedores.

Tipo: matriz de objetos

Requerido: no

Las asignaciones de puertos exponen los puertos de red del contenedor al mundo exterior, lo que permite a los clientes acceder a su aplicación. También se utilizan para la comunicación entre contenedores dentro de la misma tarea.

Para las definiciones de tareas (tanto del tipo de lanzamiento Fargate como del EC2) que utilizan el modo de red awsvpc, especifique únicamente el containerPort. El hostPort siempre se ignora y el puerto del contenedor se asigna automáticamente a un puerto aleatorio con un número alto del host.

Las asignaciones de puertos en Windows utilizan la dirección de puerto de enlace NetNAT en lugar de localhost. No existe ningún bucle invertido para el mapeo de puertos en Windows, por lo que no puede acceder a un puerto mapeado del contenedor desde el propio host.

La mayoría de los campos de este parámetro (incluidos containerPort, hostPort, protocol) se corresponden con PortBindings en el comando create-container de docker y con la opción --publish para docker run. Si el modo de red de una definición de tareas se establece en host, los puertos de host deben estar sin definir o deben corresponder al puerto de contenedor en la asignación de puerto.

Utilice la sintaxis a continuación para especificar un puerto de host.

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

Use la siguiente sintaxis si desea asignar automáticamente un puerto de host.

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

Tipo: objeto de RepositoryCredentials

Requerido: no

Las credenciales del repositorio para la autenticación de registros privados.

Para obtener más información, consulte Uso de imágenes de contenedor que no sean de AWS en Amazon ECS.

La política de reinicio del contenedor y los parámetros de configuración asociados. Al configurar una política de reinicio para un contenedor, Amazon ECS puede reiniciar el contenedor sin necesidad de reemplazar la tarea. Para obtener más información, consulte Reinicio de contenedores individuales en tareas de Amazon ECS con políticas de reinicio de contenedores.

El parámetro de comprobación de estado del contenedor y los parámetros de configuración asociados para el contenedor. Para obtener más información, consulte Determine el estado de las tareas de Amazon ECS mediante comprobaciones de estado de los contenedores.

Tipo: entero

Requerido: no

El número de unidades de cpu que el agente de contenedor de Amazon ECS reserva para el contenedor. En Linux, este parámetro se corresponde con CpuShares en la sección Crear un contenedor.

Este campo es opcional para las tareas que utilizan el tipo de lanzamiento de Fargate. La cantidad total de CPU reservada para todos los contenedores dentro de una tarea debe ser menor que el valor cpu de la tarea.

Los contenedores de Linux comparten unidades de CPU no asignadas con otros contenedores en la instancia de contenedor en la misma proporción que la cantidad asignada. Por ejemplo, supongamos que ejecuta una tarea de contenedor único en un tipo de instancia de un solo núcleo con 512 unidades de CPU especificadas para dicho contenedor. Además, esa tarea es la única que se ejecuta en la instancia de contenedor. En este ejemplo, el contenedor puede utilizar la cuota completa de 1024 unidades de CPU en un momento dado. Sin embargo, supongamos que lanzó otra copia de la misma tarea en esa instancia de contenedor. Cada tarea tiene garantizado un mínimo de 512 unidades de CPU cuando sea necesario. Del mismo modo, si el otro contenedor no utiliza la CPU restante, cada contenedor puede aumentar el uso de la CPU. Sin embargo, si ambas tareas estuvieran 100 % activas todo el tiempo, están limitadas a 512 unidades de CPU.

En las instancias de contenedor de Linux, el daemon de Docker en la instancia de contenedor utiliza el valor de CPU para calcular las proporciones de cuota de CPU relativas para los contenedores en ejecución. El valor de cuota de CPU válido mínimo que permite el kernel de Linux es 2 y el valor de cuota de CPU válido máximo que permite el kernel de Linux es 262144. Sin embargo, el parámetro de CPU no es obligatorio y puede utilizar valores de CPU por debajo de 2 y por encima de 262144 en las definiciones de contenedor. Para valores de CPU por debajo de 2 (incluido el valor nulo) y por encima de 262144, el comportamiento varía en función de la versión de agente de contenedor de Amazon ECS:

En las instancias de contenedor de Windows, la cuota de CPU se aplica como una cuota absoluta. Los contenedores de Windows solo tienen acceso a la cantidad de CPU especificada que se establece en la definición de tareas. Un valor de CPU nulo o cero se pasa a Docker como0. A continuación, Windows interpreta este valor como el 1 % de una CPU.

Para ver otros ejemplos, consulte Cómo administra Amazon ECS los recursos de CPU y memoria.

Tipo: objeto ResourceRequirement

Requerido: no

El número de GPUs físicas que el agente de contenedor de Amazon ECS reserva para el contenedor. El número de GPU reservadas para todos los contenedores de una tarea no debe superar el número de GPU disponibles en la instancia de contenedor en la que se lanza la tarea. Para obtener más información, consulte Definiciones de tareas de Amazon ECS para cargas de trabajo de GPU.

Tipo: objeto ResourceRequirement

Requerido: no

Para el tipo InferenceAccelerator, el value coincide con el deviceName para un InferenceAccelerator especificado en una definición de tareas. Para obtener más información, consulte Nombre del acelerador de Elastic Inference.

Tipo: Booleano

Requerido: no

Supongamos que el parámetro essential de un contenedor se marca como true y dicho contenedor falla o se detiene por algún motivo. A continuación, se detienen todos los demás contenedores que forman parte de la tarea. Si el parámetro essential de un contenedor se marca como false, su error no afecta al resto de los contenedores en una tarea. Si este parámetro se omite, se supone que un contenedor es esencial.

Todas las tareas deben tener al menos un contenedor esencial. Supongamos que tiene una aplicación compuesta por varios contenedores. Agrupe los contenedores que se utilizan para un fin común en componentes y sepárelos en diversas definiciones de tareas. Para obtener más información, consulte Diseño de la arquitectura de su aplicación para Amazon ECS.

"essential": true|false

Tipo: matriz de cadenas

Requerido: no

El punto de entrada que se transfiere al contenedor.

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

Tipo: matriz de cadenas

Requerido: no

El comando que se transfiere al contenedor. Este parámetro se corresponde con Cmd en el comando create-container y el parámetro COMMAND para ejecutar el docker. Si hay varios argumentos, asegúrese de que cada uno de ellos sea una cadena distinta en la matriz.

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

Tipo: cadena

Requerido: no

El directorio de trabajo para ejecutar los comandos dentro del contenedor. Este parámetro se corresponde con WorkingDir en la sección Crear un contenedor de la API remota de Docker y con la opción --workdir de docker container run.

"workingDirectory": "string"

Tipo: matriz de objetos

Requerido: no

Una lista de archivos que contienen las variables de entorno que transferir a un contenedor. Este parámetro se corresponde con la opción --env-file del comando de docker run.

Cuando se habilita FIPS en un host que utiliza el tipo de lanzamiento EC2, los nombres de los buckets que tienen puntos (.) (por ejemplo, amzn-s3-demo-bucket1.name.example) no son compatibles. Tener puntos (.) en el nombre del bucket impide que la tarea se inicie porque el agente no puede extraer el archivo de variables de entorno de Amazon S3.

No está disponible para los contenedores de Windows ni los contenedores de Windows en Fargate

Puede especificar hasta diez archivos de entorno. El archivo debe tener una extensión de archivo .env. Cada línea de un archivo de entorno contiene una variable de entorno con el formato VARIABLE=VALUE. Las líneas que comienzan por # se tratan como comentarios y se ignoran.

Si hay variables de entorno individuales especificadas en la definición del contenedor, tienen prioridad sobre las variables que contiene un archivo de entorno. Si se especifican varios archivos de entorno que contienen la misma variable, se procesan en orden descendente. Le recomendamos que utilice nombres de variables únicos. Para obtener más información, consulte Transferencia de una variable de entorno individual a un contenedor de Amazon ECS.

Tipo: matriz de objetos

Requerido: no

Las variables de entorno a transferir a un contenedor. Este parámetro se corresponde con Env en el comando create-container de docker y la opción --env con el comando de docker run.

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

Tipo: matriz de objetos

Requerido: no

Un objeto que representa el secreto que se expone en el contenedor. Para obtener más información, consulte Transferencia de datos confidenciales a un contenedor de Amazon ECS.

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

Tipo: Booleano

Requerido: no

Cuando este parámetro es verdadero, la conexión en red está apagada dentro del contenedor.

El valor predeterminado es false.

"disableNetworking": true|false

Tipo: matriz de cadenas

Requerido: no

El parámetro link permite a los contenedores comunicarse entre sí sin la necesidad de mapeos de puerto. Este parámetro solo se admite si el modo de red de una definición de tarea se establece en bridge. El constructo name:internalName es análogo a name:alias en enlaces de Docker. Se admiten hasta 255 letras (mayúsculas y minúsculas), números, guiones y caracteres de subrayado.

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

Tipo: cadena

Requerido: no

El nombre de host que utilizar para el contenedor. Este parámetro se asigna a Hostname en el comando create-container de docker y la opción --hostname con docker run.

"hostname": "string"

Tipo: matriz de cadenas

Requerido: no

Una lista de servidores DNS que se presentan al contenedor.

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

Tipo: matriz de cadenas

Requerido: no

Patrón: ^[a-zA-Z0-9-.]{0,253}[a-zA-Z0-9]$

Una lista de dominios de búsqueda DNS que se presentan al contenedor. Este parámetro se corresponde con DnsSearch en el comando create-container de docker y la opción --dns-search con docker run.

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

Tipo: matriz de objetos

Requerido: no

Una lista de nombres de host y mapeos de direcciones IP que añadir al archivo /etc/hosts en el contenedor.

Este parámetro se corresponde con ExtraHosts en el comando create-container de docker y la opción --add-host se corresponde con docker run.

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

Tipo: Booleano

Obligatorio: no

Cuando este parámetro es verdadero, al contenedor se le concede acceso de solo lectura a su sistema de archivos raíz. Este parámetro se corresponde con ReadonlyRootfs en el comando create-container de docker y la opción --read-only con docker run.

El valor predeterminado es false.

"readonlyRootFilesystem": true|false

Tipo: matriz de objetos

Requerido: no

Puntos de montaje para los volúmenes de datos del contenedor. Este parámetro asigna a Volumes en la API create-container de Docker y la opción --volume a docker run.

Los contenedores de Windows pueden montar directorios completos en la misma unidad que $env:ProgramData. Los contenedores de Windows no pueden montar directorios en una unidad diferente y los puntos de montaje no se pueden utilizar entre unidades. Debe especificar los puntos de montaje para adjuntar un volumen de Amazon EBS directamente a una tarea de Amazon ECS.

Tipo: matriz de objetos

Requerido: no

Volúmenes de datos que montar desde otro contenedor. Este parámetro se corresponde con VolumesFrom en el comando create-container de docker y la opción --volumes-from se corresponde con docker run.

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

Tipo: objeto LogConfiguration

Requerido: no

La especificación de configuración de registros para el contenedor.

Para obtener ejemplos de definiciones de tareas que utilizan una configuración de registro, consulte Ejemplo de definiciones de tareas de Amazon ECS.

Este parámetro se corresponde con LogConfig en el comando create-container de docker y la opción --log-driver se corresponde con docker run. De forma predeterminada, los contenedores utilizan el mismo controlador de registro que el daemon de Docker. No obstante, el contenedor podría utilizar un controlador de registro diferente al daemon de Docker especificando un controlador de registro con este parámetro en la definición de contenedor. Para utilizar un controlador de registro distinto para un contenedor, el sistema de registro se debe configurar correctamente en la instancia de contenedor (o en un servidor de registro distinto para opciones de registro remotas).

Tenga cuenta lo siguiente al especificar una configuración de registros para los contenedores:

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

Tipo: objeto FirelensConfiguration

Requerido: no

La configuración de FireLens para el contenedor. Esto se utiliza para especificar y configurar un enrutador de registro para registros de contenedores. Para obtener más información, consulte Envío de registros de Amazon ECS a un servicio de AWS o AWS Partner.

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

Tipo: matriz de cadenas

Requerido: no

Una lista de los ARN de SSM o Amazon S3 en un archivo de especificaciones de credenciales (CredSpec) que configura el contenedor para la autenticación de Active Directory. Le recomendamos que utilice este parámetro en lugar de dockerSecurityOptions. El número máximo de ARN es 1.

Hay dos formatos para cada ARN.

En ambos formatos, sustituya MyARN por el ARN en SSM o Amazon S3.

La credspec debe proporcionar un ARN en Secrets Manager para un secreto que contenga el nombre de usuario, la contraseña y el dominio para conectarse. Para mayor seguridad, la instancia no está unida al dominio para la autenticación sin dominio. Las demás aplicaciones de la instancia no pueden utilizar las credenciales sin dominio. Puede utilizar este parámetro para ejecutar tareas en la misma instancia, incluso si las tareas necesitan unirse a dominios diferentes. Para obtener más información, consulte Uso de gMSA para contenedores de Windows y Uso de gMSA para contenedores de Linux.

Tipo: Booleano

Requerido: no

Cuando este parámetro es verdadero, al contenedor se le conceden privilegios elevados en la instancia de contenedor de host, similares a los de un usuario root. Recomendamos no utilizar contenedores con privileged. En la mayoría de los casos, puede especificar los privilegios exactos que necesita mediante los parámetros específicos en lugar de usar privileged.

Este parámetro se corresponde con Privileged en el comando create-container de docker y la opción --privileged con docker run.

El valor predeterminado es false.

"privileged": true|false

Tipo: cadena

Requerido: no

El usuario que se utiliza dentro del contenedor. Este parámetro se corresponde con User en el comando create-container de docker y la opción --user con docker run.

Puede especificar el elemento user utilizando los siguientes formatos. Si se especifica un UID o GID, debe especificarlo como número entero positivo.

"user": "string"

Tipo: matriz de cadenas

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

Requerido: no

Una lista de cadenas para proporcionar una configuración personalizada para varios sistemas de seguridad. Este campo no es válido para contenedores en tareas con el tipo de lanzamiento de Fargate.

Para las tareas de Linux en EC2, este parámetro se puede utilizar para hacer referencia a etiquetas personalizadas para sistemas de seguridad de varios niveles de SELinux y AppArmor .

Para cualquier tarea en EC2, este parámetro se puede utilizar para hacer referencia a un archivo de especificación de credenciales que configure un contenedor para la autenticación de Active Directory. Para obtener más información, consulte Obtenga información sobre cómo utilizar gMSA para contenedores de EC2 para Windows en Amazon ECS. y Uso de gMSA para contenedores de EC2 Linux en Amazon ECS.

Este parámetro se corresponde con SecurityOpt en el comando create-container de docker y la opción --security-opt se corresponde con docker run.

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

Tipo: matriz de objetos

Requerido: no

Lista de valores ulimit a definir para un contenedor. Este valor sobrescribe la configuración predeterminada de la cuota de recursos para el sistema operativo. Este parámetro se corresponde con Ulimits en el comando create-container de docker y la opción --ulimit se corresponde con docker run.

Las tareas de Amazon ECS alojadas en Fargate utilizan los valores límite de recursos predeterminados que establece el sistema operativo, a excepción del parámetro límite de recursos nofile. El límite de recursos nofile define una restricción en el número de archivos abiertos que puede utilizar un contenedor. En Fargate, el límite flexible nofile predeterminado es 65535 y el límite invariable es 65535. Puede establecer los valores de ambos límites en un valor máximo de 1048576. Para obtener más información, consulte Límites de recursos de tareas.

Este parámetro requiere la versión 1.18 de la API remota de Docker o superior en su instancia de contenedor.

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

Tipo: mapa de cadena a cadena

Requerido: no

Un mapa de clave/valor de etiquetas que agregar al contenedor. Este parámetro se corresponde con Labels en el comando create-container de docker y la opción --label se corresponde con docker run.

Este parámetro requiere la versión 1.18 de la API remota de Docker o superior en su instancia de contenedor.

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

Tipo: objeto LinuxParameters

Requerido: no

Opciones específicas de Linux que se aplican al contenedor, como KernelCapabilities.

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

Tipo: matriz de objetos ContainerDependency

Requerido: no

Las dependencias definidas para el inicio y apagado del contenedor. Un contenedor puede contener varias dependencias. Cuando una dependencia se define para el inicio del contenedor, se invierte para el apagado del contenedor. Para ver un ejemplo, consulte Dependencia de contenedor.

Para las tareas de Amazon ECS que están alojadas en instancias de Amazon EC2, las instancias requieren al menos la versión 1.26.0 del agente de contenedor para habilitar las dependencias del contenedor. No obstante, recomendamos utilizar la versión del agente de contenedor más reciente. Para obtener información sobre la comprobación de la versión del agente y la actualización a la versión más reciente, consulte Actualización del agente de contenedor de Amazon ECS. Si utiliza una AMI de Amazon Linux optimizada para Amazon ECS, la instancia necesita al menos la versión 1.26.0-1 del paquete ecs-init. Si las instancias de contenedor se lanzan desde la versión 20190301 o posterior, contienen las versiones requeridas del agente de contenedor y ecs-init. Para obtener más información, consulte AMI de Linux optimizadas para Amazon ECS.

Para las tareas de Amazon ECS que están alojadas en Fargate, este parámetro requiere que la tarea o el servicio utilicen la versión de la plataforma 1.3.0 o una posterior (Linux) o 1.0.0 (Windows).

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

Tipo: entero

Requerido: no

Valores de ejemplo: 120

Tiempo que hay que esperar (en segundos) antes de desistir en resolver dependencias para un contenedor.

Por ejemplo, se especifican dos contenedores en una definición de tareas donde containerA tenga una dependencia en containerB que alcance un estado COMPLETE, SUCCESS o HEALTHY. Si se especifica un valor startTimeout para containerB y este no alcanza el estado deseado en ese tiempo, containerA no se inicia.

Para las tareas de Amazon ECS que están alojadas en Fargate, este parámetro requiere que la tarea o el servicio utilice la versión de la plataforma 1.3.0 o una posterior (Linux). El valor máximo es 120 segundos.

Tipo: entero

Requerido: no

Valores de ejemplo: 120

Duración de tiempo (en segundos) que esperar a que el contenedor se cancelen de forma forzada si no sale de forma normal por sí mismo.

Para las tareas de Amazon ECS que están alojadas en Fargate, este parámetro requiere que la tarea o el servicio utilice la versión de la plataforma 1.3.0 o una posterior (Linux). Si no se especifica el parámetro, se utiliza el valor predeterminado de 30 segundos. El valor máximo para Fargate es 120 segundos.

Para las tareas que utilizan el tipo de lanzamiento de EC2, si no se especifica el parámetro stopTimeout, se utiliza el valor establecido para la variable de configuración del agente de contenedor de Amazon ECS ECS_CONTAINER_STOP_TIMEOUT. Si no se establece ni el parámetro stopTimeout ni la variable de configuración del agente ECS_CONTAINER_STOP_TIMEOUT, se utilizan los valores predeterminados de 30 segundos para los contenedores Linux y de 30 segundos en contenedores de Windows. Las instancias de contenedor requieren al menos la versión 1.26.0 del agente de contenedor para habilitar un valor de tiempo de espera de parada de contenedor. No obstante, recomendamos utilizar la versión del agente de contenedor más reciente. Para obtener información acerca de cómo comprobar la versión del agente y actualizar a la versión más reciente, consulte Actualización del agente de contenedor de Amazon ECS. Si utiliza la AMI de Amazon Linux optimizada para Amazon ECS, la instancia necesita al menos la versión 1.26.0-1 del paquete ecs-init. Si las instancias de contenedor se lanzan desde la versión 20190301 o posterior, contienen las versiones requeridas del agente de contenedor y ecs-init. Para obtener más información, consulte AMI de Linux optimizadas para Amazon ECS.

Tipo: objeto SystemControl

Requerido: no

Una lista de parámetros de kernel del espacio de nombres que se van a establecer en el contenedor. Este parámetro se corresponde con Sysctls en el comando create-container de docker y la opción --sysctl con docker run. Por ejemplo, puede configurar la configuración net.ipv4.tcp_keepalive_time para mantener conexiones de mayor duración.

No se recomienda especificar parámetros systemControls relacionados con la red para varios contenedores en una única tarea que también utilice el modo de red awsvpc u host. De ese modo, se obtienen las siguientes desventajas:

Si configura un espacio de nombres de recursos de IPC para usarlo para los contenedores de la tarea, se aplican las siguientes condiciones a los controles del sistema. Para obtener más información, consulte Modo IPC.

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

Tipo: Booleano

Requerido: no

Si este parámetro es true, puede implementar aplicaciones en contenedores que requieran la asignación de stdin o un tty. Este parámetro se corresponde con OpenStdin en el comando create-container de docker y la opción --interactive con docker run.

El valor predeterminado es false.

Tipo: Booleano

Requerido: no

Cuando este parámetro es true, se asigna un TTY. Este parámetro se corresponde con Tty en el comando create-container de docker y la opción --tty con docker run.

El valor predeterminado es false.

Tipo: cadena

Obligatorio: sí

Nombre del dispositivo del acelerador de inferencia elástica. También debe hacerse referencia a deviceName en una definición de contenedor. Consulte Elastic Inference accelerator.

Tipo: cadena

Obligatorio: sí

El tipo de acelerador de Elastic Inference que se va a utilizar.

Tipo: cadena

Requerido: no

Una expresión de lenguaje de consulte de clúster que aplicar a la restricción. Para obtener más información, consulte Creación de expresiones para definir instancias de contenedor para las tareas de Amazon ECS.

Tipo: cadena

Obligatorio: sí

El tipo de restricción. Utilice memberOf para restringir la selección a un grupo de candidatos válidos.

Tipo: objeto ProxyConfiguration

Requerido: no

Los detalles de configuración del proxy App Mesh.

Para las tareas que utilizan el tipo de lanzamiento de EC2, las instancias de contenedor requieren al menos la versión 1.26.0 del agente de contenedor y al menos la versión 1.26.0-1 del paquete ecs-init para habilitar una configuración de proxy. Si las instancias de contenedor se lanzan desde la versión de AMI optimizada para Amazon ECS 20190301 o posterior, entonces contienen las versiones requeridas del agente de contenedor y ecs-init. Para obtener más información, consulte AMI de Linux optimizadas para Amazon ECS.

Para las tareas que utilizan el tipo de lanzamiento de Fargate, esta característica requiere que la tarea o servicio utilicen la versión 1.3.0 de la plataforma o una posterior.

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

Tipo: cadena

Requerido: no

El nombre del volumen. Se admiten hasta 255 letras (mayúsculas y minúsculas), números, guiones (-) y caracteres de subrayado (_). Se hace referencia a este nombre en el parámetro sourceVolume del objeto mountPoints de la definición de contenedor.

Requerido: no

El parámetro host se utiliza para vincular el ciclo de vida del montaje de enlace a la instancia de Amazon EC2 del host, en lugar de a la tarea, y donde se almacena. Si el parámetro host está vacío, entonces el daemon de Docker asigna una ruta de host a su volumen de datos, pero no se garantiza que los datos persistan después de que los contenedores asociados dejen de funcionar.

Los contenedores de Windows pueden montar directorios completos en la misma unidad que $env:ProgramData.

Tipo: Booleano

Requerido: no

Indica si un volumen se puede configurar durante el lanzamiento. Cuando se establece en true, puede configurarlo al ejecutar una tarea independiente o al crear o actualizar un servicio. Cuando se establece en true, no podrá proporcionar otra configuración de volumen en la definición de la tarea. Este parámetro se debe establecer en true para configurar un volumen de Amazon EBS para adjuntarlo a una tarea. Establecer configuredAtLaunch en true y aplazar la configuración del volumen hasta la fase de lanzamiento permite crear definiciones de tareas que no se limitan a un tipo de volumen o a una configuración de volumen específica. De este modo, la definición de la tarea se puede reutilizar en distintos entornos de ejecución. Para obtener más información, consulte Volúmenes de Amazon EBS.

Type: objeto de DockerVolumeConfiguration

Requerido: no

Este parámetro se especifica cuando se usan volúmenes de Docker. Los volúmenes de Docker se admiten solo cuando se ejecutan tareas en instancias de EC2. Los contenedores de Windows admiten solo el uso del controlador local. Para utilizar montajes vinculados, especifique host en su lugar.

Tipo: objeto de EFSVolumeConfiguration

Requerido: no

Este parámetro se especifica cuando se usan volúmenes de Amazon EFS.

Tipo: objeto de FSXWindowsFileServerVolumeConfiguration

Obligatorio: sí

Este parámetro se indica cuando se utiliza el sistema de archivos Amazon FSx para Windows File Server para el almacenamiento de tareas.

Tipo: cadena

Requerido: no

Una parte de un par clave-valor que compone una etiqueta. Un clave es una etiqueta general que actúa como una categoría para valores de etiqueta más específicos.

Tipo: cadena

Requerido: no

La parte opcional de un par clave-valor que compone una etiqueta. Un valor actúa como un descriptor en una categoría de etiquetas (clave).

Tipo: objeto de EphemeralStorage

Requerido: no

Cantidad de almacenamiento efímero (en GB) que se va a asignar para la tarea. Este parámetro se utiliza para expandir la cantidad total de almacenamiento efímero disponible, más allá de la cantidad predeterminada, para las tareas que están alojadas en AWS Fargate. Para obtener más información, consulte Uso de montajes de unión con Amazon ECS.

Tipo: cadena

Requerido: no

El espacio de nombres de recurso de IPC que usarán los contenedores de la tarea. Los valores válidos son host, task o none. Si se especifica host, todos los contenedores que están dentro de las tareas que tienen especificado el modo de IPC host en la misma instancia de contenedor comparten los mismos recursos de IPC con la instancia Amazon EC2 del host. Si se especifica task, todos los contenedores que están dentro de la tarea especificada comparten los mismos recursos de IPC. Si se especifica none, los recursos de IPC dentro de los contenedores de una tarea son privados y no se comparten con otros contenedores en una tarea o en la instancia de contenedor. Si no se especifica ningún valor, el uso compartido del espacio de nombre de recursos de IPC depende de la configuración del daemon de Docker en la instancia de contenedor.

Si se utiliza el modo de IPC host, existe un mayor riesgo de exposición de espacio de nombres de IPC no deseada.

Si configura parámetros del kernel del espacio de nombres mediante systemControls para los contenedores de la tarea, se aplica lo siguiente a su espacio de nombres de recursos de IPC.

Tipo: cadena

Valores válidos: host | task

Requerido: no

El espacio de nombres del proceso que usarán los contenedores de la tarea. Los valores válidos son host o task. En los contenedores de Fargate para Linux, el único valor válido es task. Por ejemplo, la supervisión de los archivos sidecar puede necesitar pidMode para acceder a información sobre otros contenedores que se ejecutan en la misma tarea.

Si se especifica host, todos los contenedores dentro de las tareas que tienen especificado el modo de PID host en la misma instancia de contenedor comparten el mismo espacio de nombres del proceso con la instancia Amazon EC2 del host.

Si se especifica task, todos los contenedores dentro de la tarea especificada comparten el mismo espacio de nombres del proceso.

Si no se especifica ningún valor, el valor predeterminado es un espacio de nombre privado para cada contenedor.

Si se utiliza el modo de PID host, existe un mayor riesgo de exposición de espacio de nombres del proceso no deseada.