Familia Tipos de lanzamiento Rol de la tarea Rol de ejecución de tareas Modo de red Plataforma de tiempo de ejecución Tamaño de tarea Definiciones de contenedores Nombre del acelerador de Elastic Inference Restricciones para ubicación de tareas Configuración del proxy Volúmenes Etiquetas Otros parámetros de definición de tarea

Parámetros de definición de tarea

Las definiciones de tareas se dividen en partes separadas: la familia de tareas, la función de la tarea AWS Identity and Access Management (IAM), el modo de red, las definiciones de los contenedores, los volúmenes, las restricciones de ubicación de las tareas y los tipos de lanzamiento. En una definición de tareas, son necesarias las definiciones de familia y contenedor. En cambio, el rol de tarea, el modo de red, los volúmenes, las restricciones de ubicación de tareas y el tipo de lanzamiento son opcionales.

Puede utilizar estos parámetros en un archivo JSON para configurar la definición de tarea. Para obtener más información, consulte Ejemplos de definiciones de tareas con opción de registro.

A continuación, se muestran las descripciones de cada uno de los parámetros de definición de tareas.

Familia

family

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.

Tipos de lanzamiento

Cuando se registre una definición de tareas, puede especificar un tipo de lanzamiento con respecto al cual Amazon ECS debe validar la definición de tareas. Si la definición de tareas no se valida con respecto a las compatibilidades especificadas, se devuelve una excepción de cliente. Para obtener más información, consulte Tipos de lanzamiento de Amazon ECS.

El parámetro a continuación está permitido en una definición de tareas.

requiresCompatibilities

Tipo: matriz de cadenas

Obligatorio: 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.

Rol de la tarea

taskRoleArn

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 para la tarea.

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 para los roles de IAM para las tareas de Windows.

Rol de ejecución de tareas

executionRoleArn

Tipo: cadena

Obligatorio: condicional

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

nota

El rol de IAM de ejecución de tareas es necesario en función de los requisitos de la tarea. Para obtener más información, consulte Rol de IAM de ejecución de tareas de Amazon ECS.

Modo de red

networkMode

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 default. Para las tareas de Amazon ECS alojadas en Fargate, se requiere el modo awsvpc de red.

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.

importante

Para mayor seguridad, cuando ejecute tareas utilizando el modo de red host, no debe ejecutar contenedores con el usuario raíz (UID 0). Como práctica recomendada de seguridad, utilice siempre un usuario que no sea usuario raíz.

Para los tipos de lanzamiento de Amazon EC2, si el modo de red esawsvpc, a la tarea se le asigna una interfaz de red elástica y debe especificar una NetworkConfiguration cuando cree un servicio o ejecute una tarea con la definición de la tarea. Para obtener más información, consulte Redes de tareas para tareas en instancias de Amazon 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 esawsvpc, a la tarea se le asigna una interfaz de red elástica y debe especificar una NetworkConfiguration cuando cree un servicio o ejecute una tarea con la definición de la tarea. Para obtener más información, consulte Fargate Task Networking. 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.

Plataforma de tiempo de ejecución

operatingSystemFamily

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.

cpuArchitecture

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 Uso de cargas de trabajo de ARM de 64 bits en Amazon ECS.

Tamaño de tarea

Cuando se registra una definición de tareas, puede especificar la cantidad total de CPU y memoria usada para la tarea. Es distinto de los valores cpu y memory en el nivel de definición de contenedor. Para las tareas que están alojadas en instancias de Amazon EC2, estos campos son opcionales. Para las tareas que están alojadas en Fargate (tanto en Linux como en Windows), estos campos son obligatorios y se admiten valores específicos para cpu y memory.

nota

Los parámetros de CPU y memoria de nivel de tarea se omiten para los contenedores de Windows. Le recomendamos que especifique recursos de nivel de contenedor para los contenedores de Windows.

El siguiente parámetro está permitido en una definición de tarea:

cpu

Tipo: cadena

Obligatorio: condicional

nota

Este parámetro no es compatible con contenedores Windows.

El límite máximo de unidades de CPU que presentar para la tarea. Se puede expresar utilizando unidades de CPU (por ejemplo1024) o vCPU (por ejemplo1 vCPU, 1 vcpu o) en una definición de tarea. 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.

Valor de CPU	Valor de memoria	Sistemas operativos admitidos por AWS Fargate
256 (0,25 vCPU)	512 MiB, 1 GB, 2 GB	Linux
512 (0,5 vCPU)	1 GB, 2 GB, 3 GB, 4 GB	Linux
1024 (1 vCPU)	2 GB, 3 GB, 4 GB, 5 GB, 6 GB, 7 GB, 8 GB	Linux, Windows
2048 (2 vCPU)	Entre 4 GB y 16 GB en incrementos de 1 GB	Linux, Windows
4096 (4 vCPU)	Entre 8 GB y 30 GB en incrementos de 1 GB	Linux, Windows
8192 (8 vCPU) nota Esta opción requiere una plataforma Linux `1.4.0` o posterior.	Entre 16 GB y 60 GB en incrementos de 4 GB	Linux
16 384 (16 vCPU) nota Esta opción requiere una plataforma Linux `1.4.0` o posterior.	Entre 32 GB y 120 GB en incrementos de 8 GB	Linux

memory

Tipo: cadena

Obligatorio: condicional

nota

Este parámetro no es compatible con contenedores Windows.

El límite máximo de memoria (en MiB) que presentar a la tarea. Se puede expresar usando MiB (por ejemplo1024) o usando GB (por ejemplo 1GB o1 GB) en una definición de tarea. 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 Gestión de memoria de instancias contenedoras.

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:

Valor de memoria (en MiB, con un valor equivalente aproximado en GB)	Valor de CPU	Sistemas operativos compatibles con Fargate
512 (0,5 GB), 1024 (1 GB), 2048 (2 GB)	256 (0,25 vCPU)	Linux
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)	512 (0,5 vCPU)	Linux
2048 (2 GB), 3072 (3 GB), 4096 (4GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)	1024 (1 vCPU)	Linux, Windows
Entre 4096 (4 GB) y 16384 (16 GB) en incrementos de 1024 (1 GB)	2048 (2 vCPU)	Linux, Windows
Entre 8192 (8 GB) y 30720 (30 GB) en incrementos de 1024 (1 GB)	4096 (4 vCPU)	Linux, Windows
Entre 16 GB y 60 GB en incrementos de 4 GB nota Esta opción requiere una plataforma Linux `1.4.0` o posterior.	8192 (8 vCPU)	Linux
Entre 32 GB y 120 GB en incrementos de 8 GB nota Esta opción requiere una plataforma Linux `1.4.0` o posterior.	16 384 (16 vCPU)	Linux

Definiciones de contenedores

Al registrar una definición de tarea, debe especificar una lista de definiciones de contenedor que se transfieren al daemon de Docker en una instancia de contenedor. Los siguientes parámetros están permitidos en una definición de contenedor.

Temas

Parámetros de definición de contenedor estándar
Parámetros de definición de contenedor avanzados
Otros parámetros de definición de contenedor

Parámetros de definición de contenedor estándar

Los siguientes parámetros de definición de tarea son obligatorios o utilizados en la mayoría de definiciones de contenedor.

Nombre

name

Tipo: cadena

Requerido: no

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.

Imagen

image

Tipo: cadena

Requerido: no

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 asigna a Image en la sección Create a container (Crear un contenedor) de la API remota de Docker y el parámetro IMAGE de docker run.

Cuando se inicia una tarea nueva, el agente de contenedor de Amazon ECS extrae la última versión de la imagen y la etiqueta especificadas para que las utilice el contenedor. Sin embargo, las actualizaciones realizadas posteriormente en un repositorio de imágenes no se propagan a las tareas en ejecución.
Se admiten las imágenes de registros privados. Para obtener más información, consulte Autenticación de registros privados para tareas.
Para especificar imágenes de los repositorios de Amazon ECR, se puede utilizar la convención de nomenclatura completa registry/repository:tag o registry/repository@digest (por ejemplo, aws_account_id.dkr.ecr.region.amazonaws.com/my-web-app:latest o aws_account_id.dkr.ecr.region.amazonaws.com/my-web-app@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE).
Las imágenes de los repositorios oficiales de Docker Hub utilizan un solo nombre (por ejemplo, ubuntu o mongo).
Las imágenes de otros repositorios de Docker Hub se clasifican con un nombre de organización (por ejemplo, amazon/amazon-ecs-agent).
Las imágenes de otros repositorios online se cualifican más con un nombre de dominio (por ejemplo, quay.io/assemblyline/ubuntu).

Memoria

memory

Tipo: entero

Obligatorio: 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 asigna a Memory en la sección Crear un contenedor de la API remota de Docker y con la opción --memory de 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.

nota

Si intenta maximizar la utilización de los recursos proporcionando a las tareas la mayor cantidad de memoria posible para un tipo de instancia determinado, consulte Gestión de memoria de instancias contenedoras.

memoryReservation

Tipo: entero

Obligatorio: 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 asigna a MemoryReservation en la sección Crear un contenedor de la API remota de Docker y con la opción --memory-reservation de 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.

nota

Este parámetro no es compatible con los contenedores de Windows.

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.

nota

Mapeos de puertos

portMappings

Tipo: matriz de objetos

Obligatorio: no

Los mapeos de puertos permiten a los contenedores acceder a puertos en las instancias de contenedor del host para enviar o recibir tráfico.

Para las definiciones de tareas que utilizan el modo de red awsvpc, solo especifique containerPort. El hostPort puede dejarse en blanco o debe ser el mismo valor que containerPort.

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 (incluido containerPort, hostPort, protocol) se asignan a PortBindings en la sección Crear un contenedor de la API remota 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.

nota

Después de que una tarea alcanza el estado RUNNING, las asignaciones manuales y automáticas de puertos de contenedor y de host se pueden ver en las siguientes ubicaciones:

Consola: la sección Network Bindings (Conexiones de red) de la descripción de un contenedor para una tarea seleccionada.
AWS CLI: la sección networkBindings de la salida del comando describe-tasks.
API: la respuesta de DescribeTasks.
Metadatos: el punto de conexión de metadatos de la tarea.

appProtocol

Tipo: cadena

Requerido: no

El protocolo de aplicación que se utiliza para la asignación de puertos. Este parámetro solo se aplica a Service Connect. Recomendamos que defina este parámetro para que sea coherente con el protocolo que utiliza la aplicación. Si se establece este parámetro, Amazon ECS agrega la administración de la conexión específica del protocolo al proxy de Service Connect. Si establece este parámetro, Amazon ECS añade telemetría específica del protocolo en la consola de Amazon ECS y. CloudWatch

Si no establece un valor para este parámetro, se utilizará TCP. Sin embargo, Amazon ECS no agrega telemetría específica del protocolo para TCP.

Para obtener más información, consulte Service Connect.

Valores de protocolo válidos: "HTTP" | "HTTP2" | "GRPC"

containerPort

Tipo: entero

Obligatorio: sí, si se utilizan portMappings.

El número de puerto en el contenedor que está vinculado al puerto de host especificado por el usuario o asignado automáticamente.

En el caso de que se utilicen los contenedores en una tarea con el tipo de lanzamiento de Fargate, los puertos expuestos se deben especificar mediante containerPort.

Para los contenedores de Windows en Fargate, no se puede utilizar el puerto 3150 para el containerPort. Esto se debe a que está reservado.

Suponga que utiliza contenedores en una tarea con el tipo de lanzamiento de EC2 y especifica un puerto de contenedor y no un puerto de host. A continuación, el contenedor recibe automáticamente un puerto de host en el rango de puertos efímeros. Para obtener más información, consulte hostPort. Las asignaciones de puerto que se asignan automáticamente de esta manera no se contabilizan en la cuota de 100 puertos reservados de una instancia de contenedor.

containerPortRange

Tipo: cadena

Requerido: no

El rango de números de puerto en el contenedor que está vinculado al rango de puertos de host asignado de manera dinámica.

Solo puede configurar este parámetro mediante la API register-task-definition. La opción está disponible en el parámetro portMappings. Para obtener más información consulte register-task-definition en la Referencia de la AWS Command Line Interface .

Las siguientes reglas se aplican al especificar un containerPortRange:

Debe utilizar el modo de red bridge o el modo de red awsvpc.
Este parámetro está disponible tanto para los tipos de lanzamiento de EC2 como los de AWS Fargate.
Este parámetro está disponible tanto para sistemas operativos Windows como Linux.
La instancia de contenedor debe tener al menos la versión 1.67.0 del agente de contenedor y al menos la versión 1.67.0-1 del paquete ecs-init
Puede especificar 100 rangos de puertos como máximo por cada contenedor.
No especifica un hostPortRange. El valor de hostPortRange se establece de la siguiente manera:
- Para los contenedores de una tarea con el modo de red awsvpc, hostPort se establece en el mismo valor que containerPort. Se trata de una estrategia de asignación estática.
- Para los contenedores en una tarea con el modo de red bridge, el agente de Amazon ECS busca los puertos de host abiertos del rango efímero predeterminado y los pasa a un docker para vincularlos a los puertos del contenedor.
Los valores válidos de containerPortRange se encuentran entre 1 y 65 535.
Un puerto solo puede incluirse en una asignación de puertos por cada contenedor.
No puede especificar rangos de puertos superpuestos.
El primer puerto del rango debe ser menor que el último puerto del rango.
Docker recomienda desactivar el docker-proxy en el archivo de configuración del daemon de Docker cuando haya una gran cantidad de puertos.

Para obtener más información, consulte el número #11185 en. GitHub

Para obtener información sobre cómo desactivar el docker-proxy en el archivo de configuración del daemon de Docker, consulte Daemon de Docker en la Guía para desarrolladores de Amazon ECS.

Puede llamar a DescribeTasks para ver los hostPortRange, que son los puertos del host que están vinculados a los puertos del contenedor.

Los rangos de puertos no se incluyen en los eventos de tareas de Amazon ECS, que se envían a EventBridge. Para obtener más información, consulte Automatice las respuestas a los errores de Amazon ECS mediante EventBridge.

hostPortRange

Tipo: string

Requerido: no

El rango de números de puerto del host que se usa con el enlace de red. Docker lo asigna y el agente de Amazon ECS lo entrega.

hostPort

Tipo: entero

Obligatorio: no

El número de puerto en la instancia de contenedor que reservar para el contenedor.

Si se utilizan los contenedores en una tarea con el tipo de lanzamiento de Fargate, hostPort puede dejarse en blanco o tener el mismo valor que containerPort.

Supongamos que utiliza contenedores en una tarea con el tipo de lanzamiento de EC2. Puede especificar un puerto de host no reservado para la asignación de puertos de su contenedor. Esto se conoce como asignación estática de puertos de host. O bien, puede omitir el hostPort (o configurarlo en 0) al especificar un containerPort. El contenedor recibe automáticamente un puerto en el rango de puertos efímeros del sistema operativo de la instancia de contenedor y la versión de Docker. Esto se conoce como asignación dinámica de puertos de host.

La versión 1.6.0 de Docker y posteriores para el rango de puertos efímeros predeterminado se puede ver en la instancia en /proc/sys/net/ipv4/ip_local_port_range. Si este parámetro de kernel no está disponible, se usa el intervalo de puertos efímeros predeterminado, de 49153–65535. No intente especificar un puerto de host en el rango de puertos efímeros. Esto se debe a que están reservados para la asignación automática. En general, los puertos bajo 32768 están fuera del rango de puertos efímeros.

Los puertos reservados predeterminados son el 22 para SSH; los puertos de Docker 2375 y 2376 y los puertos 51678-51680 del agente de contenedor de Amazon ECS. Cualquier puerto de host especificado por el usuario con anterioridad para una tarea en ejecución también se reserva mientras la tarea está en ejecución. Cuando se detiene una tarea, se libera el puerto del host. Los puertos reservados actuales se muestran en los remainingResources de la salida de describe-container-instances. Es posible que una instancia de contenedor tenga hasta 100 puertos reservados por vez, incluidos los puertos reservados predeterminados. Los puertos asignados automáticamente no se contabilizan para la cuota de 100 puertos reservados.

name

Tipo: cadena

Obligatorio: no, es obligatorio para configurar Service Connect en un servicio

El nombre que se utiliza para la asignación de puertos. Este parámetro solo se aplica a Service Connect. Este parámetro es el nombre que se utiliza en la configuración de Service Connect de un servicio.

Para obtener más información, consulte Service Connect.

En el siguiente ejemplo, se utilizan los dos campos obligatorios de Service Connect.



"portMappings": [
    {
        "name": string,
        "containerPort": integer
    }
]

protocol

Tipo: cadena

Requerido: no

El protocolo que se utiliza para la asignación de puertos. Los valores válidos son tcp y udp. El valor predeterminado es tcp.

importante

Solo tcp es compatible con Service Connect. Recuerde que tcp está implícito si este campo no está configurado.

importante

UDP solo se admite en las instancias de contenedor que se lanzaron con la versión 1.2.0 del agente de contenedor de Amazon ECS (como, por ejemplo, la AMI amzn-ami-2015.03.c-amazon-ecs-optimized) o una posterior, o con los agentes de contenedor que se han actualizado a la versión 1.3.0 o una posterior. Para actualizar el agente de contenedor a la versión más reciente, consulte Actualización del agente de contenedor de Amazon ECS.

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
    }
    ...
]

Credenciales de repositorio privado

repositoryCredentials

Tipo: objeto RepositoryCredentials

Obligatorio: no

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

Para obtener más información, consulte Autenticación de registros privados para tareas.

credentialsParameter

Tipo: cadena

Obligatorio: sí, si se utilizan repositoryCredentials.

El nombre de recurso de Amazon (ARN) del secreto que contiene las credenciales del repositorio privado.

Para obtener más información, consulte Autenticación de registros privados para tareas.

nota

Cuando utiliza la API o los AWS SDK de Amazon ECS, si el secreto existe en la misma región que la tarea que va a lanzar, puede utilizar el ARN completo o el nombre del secreto. AWS CLI Cuando utilice el AWS Management Console, debe especificar el ARN completo del secreto.

A continuación, se incluye un fragmento de definición de tareas que muestra los parámetros necesarios:



"containerDefinitions": [
    {
        "image": "private-repo/private-image",
        "repositoryCredentials": {
            "credentialsParameter": "arn:aws:secretsmanager:region:aws_account_id:secret:secret_name"
        }
    }
]

Parámetros de definición de contenedor avanzados

Los siguientes parámetros avanzados de definición de contenedor ofrecen capacidades ampliadas para el comando docker run que se utiliza para lanzar contenedores en las instancias de contenedor de Amazon ECS.

Temas

Comprobación de estado
Entorno
Network settings (Configuración de red)
Almacenamiento y registro
Seguridad
Límites de recursos
Etiquetas de Docker

Comprobación de estado

healthCheck

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 del estado de los contenedores.

command

Una matriz de cadenas que representa el comando que ejecuta el contenedor para determinar si está en buen estado. La matriz de cadenas puede comenzar por CMD para ejecutar los argumentos del comando directamente, o por CMD-SHELL para ejecutar el comando con el shell predeterminado del contenedor. Si no se especifica ninguno, se utiliza CMD.

Al registrar una definición de tarea en AWS Management Console, utilice una lista de comandos separados por comas. Estos comandos se convierten en una cadena una vez que se cree la definición de tareas. A continuación, se muestra un ejemplo de entrada de comprobación de estado.


CMD-SHELL, curl -f http://localhost/ || exit 1

Al registrar una definición de tarea mediante el panel AWS Management Console JSON AWS CLI, las API o las API, coloque la lista de comandos entre corchetes. A continuación, se muestra un ejemplo de entrada de comprobación de estado.


[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

Un código de salida de 0, sin salida stderr, indica una ejecución correcta y cualquier código de salida distinto de cero indica un error. Para obtener más información, consulte HealthCheck en la sección Crear un contenedor de la API remota de Docker.

interval

El periodo de tiempo (en segundos) entre cada comprobación de estado. Es posible especificar entre 5 y 300 segundos. El valor de predeterminado es de 30 segundos.

timeout

El periodo de tiempo (en segundos) que hay que esperar para que una comprobación de estado se realice correctamente antes de que se considere un error. Puede especificar entre 2 y 60 segundos. El valor de predeterminado es de 5 segundos.

retries

Es el número de veces que se reintenta una comprobación de estado fallida antes de que se considere que el contenedor está en mal estado. Puede especificar entre 1 y 10 reintentos. El valor predeterminado es tres reintentos.

startPeriod

El periodo de gracia opcional dentro del cual se puede proporcionar tiempo a los contenedores para el arranque antes de que una comprobación de estado fallida se cuente para el número máximo de reintentos. Es posible especificar entre 0 y 300 segundos. De forma predeterminada, startPeriod está deshabilitado.

Entorno

cpu

Tipo: entero

Obligatorio: 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 asigna a CpuShares en la sección Crear un contenedor de la API remota de Docker y con la opción --cpu-shares de docker run.

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.

nota

Puede determinar el número de unidades de CPU disponibles para cada tipo de instancia de Amazon EC2. Para ello, multiplique el número de vCPU listadas para dicho tipo de instancia en la página de detalles sobre instancias de Amazon EC2 por 1024.

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. Para obtener más información, consulte la sección CPU share constraint de la documentación de Docker. El valor de cuota de CPU válido mínimo que permite el kernel de Linux es 2. Sin embargo, el parámetro de CPU no es obligatorio, y puede utilizar valores de CPU por debajo de dos en sus definiciones de contenedor. Para valores de CPU por debajo de dos (incluido el valor nulo), el comportamiento varía en función de la versión de agente de contenedor de Amazon ECS:

Versiones del agente <= 1.1.0: los valores de CPU nulo y cero se pasan a Docker como 0, que Docker convierte a continuación a 1024 cuotas de CPU. Los valores de CPU de uno se transfieren a Docker como uno, que el kernel de Linux convierte a dos cuotas de CPU.
Versiones del agente >= 1.2.0: nulo, cero y los valores de CPU de uno se transfieren a Docker como dos cuotas de CPU.

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.

gpu

Tipo: objeto ResourceRequirement

Obligatorio: 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 Uso de GPU en Amazon ECS.

nota

Este parámetro no es compatible con los contenedores de Windows ni con los contenedores que están alojados en Fargate.

Elastic Inference accelerator

Tipo: objeto ResourceRequirement

Obligatorio: 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.

nota

A partir del 15 de abril de 2023, no AWS incorporará nuevos clientes a Amazon Elastic Inference (EI) y ayudará a los clientes actuales a migrar sus cargas de trabajo a opciones que ofrezcan un mejor precio y rendimiento. Después del 15 de abril de 2023, los nuevos clientes no podrán lanzar instancias con los aceleradores de Amazon EI en Amazon SageMaker, Amazon ECS o Amazon EC2. Sin embargo, los clientes que hayan utilizado Amazon EI al menos una vez durante los últimos 30 días se consideran clientes actuales y podrán seguir utilizando el servicio.

nota

Este parámetro no es compatible con los contenedores de Windows ni con los contenedores que están alojados en Fargate.

essential

Tipo: Booleano

Obligatorio: 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ñar la arquitectura de la aplicación.


"essential": true|false

entryPoint

importante

Las primeras versiones del agente de contenedor de Amazon ECS no tratan correctamente los parámetros entryPoint. Si tiene problemas al utilizar entryPoint , actualice el agente de contenedor o introduzca los comandos y argumentos como elementos de matriz de command en su lugar.

Tipo: matriz de cadenas

Obligatorio: no

El punto de entrada que se transfiere al contenedor. Este parámetro se asigna a Entrypoint en la sección Crear un contenedor de la API remota de Docker y con la opción --entrypoint de docker run. Para obtener más información sobre el parámetro ENTRYPOINT de Docker, consulte https://docs.docker.com/engine/reference/builder/#entrypoint.


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

command

Tipo: matriz de cadenas

Obligatorio: no

El comando que se transfiere al contenedor. Este parámetro se asigna a Cmd en la sección Crear un contenedor de la API remota de Docker y el parámetro COMMAND se corresponde con docker run. Para obtener más información sobre el parámetro CMD de Docker, consulte https://docs.docker.com/engine/reference/builder/#cmd. Si hay varios argumentos, asegúrese de que cada uno de ellos sea una cadena distinta en la matriz.


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

workingDirectory

Tipo: cadena

Requerido: no

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


"workingDirectory": "string"

environmentFiles

Tipo: matriz de objetos

Obligatorio: no

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

Esto no está disponible para los contenedores de Windows.

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. Para obtener más información sobre la sintaxis adecuada del archivo de variables de entorno, consulte Declarar variables de entorno predeterminadas en el archivo.

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 Utilice los parámetros de definición de tareas para pasar variables de entorno a un contenedor.

value

Tipo: cadena

Obligatorio: sí

Nombre de recurso de Amazon (ARN) del objeto Amazon S3 que contiene el archivo de variable de entorno.

type

Tipo: cadena

Obligatorio: sí

Tipo de archivo que se utilizará. El único valor admitido es s3.

environment

Tipo: matriz de objetos

Obligatorio: no

Las variables de entorno a transferir a un contenedor. Este parámetro se asigna a Env en la sección Crear un contenedor de la API remota de Docker y con la opción --env de docker run.

importante

No es recomendable que utilice variables del entorno en texto sin formato para información confidencial, como los datos de las credenciales.

name

Tipo: cadena

Obligatorio: sí, si se utiliza environment

El nombre de la variable de entorno.

value

Tipo: cadena

Obligatorio: sí, si se utiliza environment

El valor de la variable de entorno.


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

secrets

Tipo: matriz de objetos

Obligatorio: 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.

name

Tipo: cadena

Obligatorio: sí

El valor que se ha de establecer como la variable de entorno en el contenedor.

valueFrom

Tipo: cadena

Obligatorio: sí

El secreto para exponer en el contenedor. Los valores admitidos son el nombre de recurso de Amazon (ARN) completo del AWS Secrets Manager secreto o el ARN completo del parámetro en el almacén de parámetros. AWS Systems Manager

nota

Si el parámetro Almacén de parámetros de Systems Manager existe en la Región de AWS misma tarea que está iniciando, puede usar el ARN completo o el nombre del secreto. Si el parámetro existe en una región distinta, el ARN completo debe especificarse.


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

Network settings (Configuración de red)

disableNetworking

Tipo: Booleano

Obligatorio: no

Cuando este parámetro es verdadero, la conexión en red está apagada dentro del contenedor. Este parámetro se asigna a NetworkDisabled en la sección Crear un contenedor de la API remota de Docker.

nota

Este parámetro no es compatible con los contenedores o las tareas de Windows que utilizan el modo de red awsvpc.

El valor predeterminado es false.


"disableNetworking": true|false

links

Tipo: matriz de cadenas

Obligatorio: 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. Para obtener más información sobre la vinculación de contenedores de Docker, consulte https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. Este parámetro se asigna a Links en la sección Crear un contenedor de la API remota de Docker y con la opción --link de docker run.

nota

Este parámetro no es compatible con los contenedores o las tareas de Windows que utilizan el modo de red awsvpc.

importante

Es posible que los contenedores que se colocan en la misma instancia de contenedor puedan comunicarse entre sí sin necesidad de enlaces ni asignaciones de puerto de host. El aislamiento de red en una instancia de contenedor se controla mediante los grupos de seguridad y la configuración de VPC.


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

hostname

Tipo: cadena

Requerido: no

El nombre de host que utilizar para el contenedor. Este parámetro se asigna a Hostname en la sección Crear un contenedor de la API remota de Docker y con la opción --hostname de docker run.

nota

Si utiliza el modo de red awsvpc, el parámetro hostname no se admite.


"hostname": "string"

dnsServers

Tipo: matriz de cadenas

Obligatorio: no

Una lista de servidores DNS que se presentan al contenedor. Este parámetro se asigna a Dns en la sección Crear un contenedor de la API remota de Docker y con la opción --dns de docker run.

nota

Este parámetro no es compatible con los contenedores o las tareas de Windows que utilizan el modo de red awsvpc.


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

dnsSearchDomains

Tipo: matriz de cadenas

Obligatorio: 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 asigna a DnsSearch en la sección Crear un contenedor de la API remota de Docker y con la opción --dns-search de docker run.

nota

Este parámetro no es compatible con los contenedores o las tareas de Windows que utilizan el modo de red awsvpc.


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

extraHosts

Tipo: matriz de objetos

Obligatorio: 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 asigna a ExtraHosts en la sección Crear un contenedor de la API remota de Docker y con la opción --add-host de docker run.

nota

Este parámetro no es compatible con los contenedores o las tareas de Windows que utilizan el modo de red awsvpc.


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

hostname

Tipo: cadena

Obligatorio: sí, si se utilizan extraHosts.

El nombre de host para utilizar en la entrada /etc/hosts.

ipAddress

Tipo: cadena

Obligatorio: sí, si se utilizan extraHosts.

La dirección IP para utilizar en la entrada /etc/hosts.

Almacenamiento y registro

readonlyRootFilesystem

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 asigna a ReadonlyRootfs en la sección Crear un contenedor de la API remota de Docker y con la opción --read-only de docker run.

nota

Este parámetro no es compatible con contenedores Windows.

El valor predeterminado es false.


"readonlyRootFilesystem": true|false

mountPoints

Tipo: matriz de objetos

Obligatorio: no

Los puntos de montaje de los volúmenes de datos del contenedor. Este parámetro se asigna a Volumes en la sección Crear un contenedor de la API remota de Docker y con la opción --volume de 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 usar en todas las unidades.

sourceVolume

Tipo: cadena

Obligatorio: sí, si se utilizan mountPoints.

El nombre del volumen a montar.

containerPath

Tipo: cadena

Obligatorio: sí, si se utilizan mountPoints.

La ruta del contenedor en la que se montará el volumen.

readOnly

Tipo: Booleano

Obligatorio: no

Si este valor es true, el acceso del contenedor al volumen es de solo lectura. Si este valor es false, el contenedor puede escribir en el volumen. El valor predeterminado es false.

volumesFrom

Tipo: matriz de objetos

Obligatorio: no

Volúmenes de datos que montar desde otro contenedor. Este parámetro se asigna a VolumesFrom en la sección Crear un contenedor de la API remota de Docker y con la opción --volumes-from de docker run.

sourceContainer

Tipo: cadena

Obligatorio: sí, si se utiliza volumesFrom

El nombre del volumen contenedor desde el que montar los volúmenes.

readOnly

Tipo: Booleano

Obligatorio: no

Si este valor es true, el acceso del contenedor al volumen es de solo lectura. Si este valor es false, el contenedor puede escribir en el volumen. El valor predeterminado es false.


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

logConfiguration

Tipo: LogConfigurationobjeto

Obligatorio: 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 Ejemplos de definiciones de tarea.

Este parámetro se asigna a LogConfig en la sección Crear un contenedor de la API remota de Docker y con la opción --log-driver de 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). Para obtener más información sobre las opciones para los distintos controladores de registro admitidos, consulte Configurar controladores de registro en la documentación de Docker.

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

Amazon ECS admite un subconjunto de controladores de registro disponibles para el daemon de Docker. Es posible que haya controladores de registro adicionales en versiones futuras del agente de contenedor de Amazon ECS.
Este parámetro requiere la versión 1.18 o posterior de la API remota de Docker en la instancia de contenedor.
Para las tareas que utilizan el tipo de lanzamiento de EC2, el agente de contenedor de Amazon ECS que se ejecuta en una instancia de contenedor debe registrar los controladores de registro que están disponibles en dicha instancia con la variable de entorno ECS_AVAILABLE_LOGGING_DRIVERS antes de que los contenedores colocados en dicha instancia puedan utilizar estas opciones de configuración de registros. Para obtener más información, consulte Configuración del agente de contenedor de Amazon ECS.
Para las tareas que utilizan el tipo de lanzamiento de Fargate, como no tiene acceso a la infraestructura subyacente donde se alojan las tareas, cualquier software adicional necesario se debe instalar fuera de la tarea. Por ejemplo, los agregadores de salida de Fluentd o un host remoto que ejecute Logstash adonde se envían los registros de Gelf.


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

logDriver

Tipo: cadena

Valores válidos: "awslogs","fluentd","gelf","json-file","journald","logentries","splunk","syslog","awsfirelens"

Obligatorio: sí, si se utiliza logConfiguration

El controlador de registro que utilizar para el contenedor. De forma predeterminada, los valores válidos mostrados anteriormente son controladores de registro con los que el agente de contenedor de Amazon ECS se puede comunicar.

Para las tareas que utilizan el tipo de lanzamiento de Fargate, los controladores de registro admitidos son awslogs, splunk y awsfirelens.

Para las tareas que utilizan el tipo de lanzamiento de EC2, los controladores de registro admitidos son awslogs, fluentd, gelf, json-file, journald, logentries, syslog, splunk y awsfirelens.

Para obtener más información sobre cómo utilizar el controlador de awslogs registro en las definiciones de tareas para enviar los registros del contenedor a CloudWatch Logs, consulteUso del controlador de registros awslogs.

Para obtener más información sobre el uso del controlador del registro awsfirelens, consulte Envío de registros personalizados.

nota

Si tienes un controlador personalizado que no aparece en la lista, puedes bifurcar el proyecto de agente de contenedores de Amazon ECS que está disponible en él GitHub y personalizarlo para que funcione con ese controlador. Le recomendamos enviar solicitudes de inserción para los cambios que desea que incluyamos. No obstante, actualmente no admitimos la ejecución de copias modificadas de este software.

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

options

Tipo: mapa de cadena a cadena

Obligatorio: no

Las opciones de configuración de asignación clave/valor para enviar al controlador de registro.

Cuando se utiliza FireLens para enrutar los registros a un AWS Partner Network destino Servicio de AWS o a un lugar para almacenarlos y analizarlos, puede configurar la log-driver-buffer-limit opción para limitar el número de eventos que se almacenan en la memoria antes de enviarlos al contenedor del router de registros. Puede ayudar a resolver el posible problema de pérdida de registros porque un alto rendimiento podría provocar que se quede sin memoria para el búfer dentro de Docker. Para obtener más información, consulte Límite de búfer de Fluentd.

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

secretOptions

Tipo: matriz de objetos

Obligatorio: no

Un objeto que representa el secreto que transferir a la configuración de registro. Los secretos utilizados en la configuración de registros pueden incluir un token de autenticación, un certificado o una clave de cifrado. Para obtener más información, consulte Transferencia de datos confidenciales a un contenedor.

name

Tipo: cadena

Obligatorio: sí

El valor que se ha de establecer como la variable de entorno en el contenedor.

valueFrom

Tipo: cadena

Obligatorio: sí

El secreto que exponer a la configuración de registro del contenedor.


"logConfiguration": {
	"logDriver": "splunk",
	"options": {
		"splunk-url": "https://cloud.splunk.com:8080",
		"splunk-token": "...",
		"tag": "...",
		...
	},
	"secretOptions": [{
		"name": "splunk-token",
		"valueFrom": "/ecs/logconfig/splunkcred"
	}]
}

firelensConfiguration

Tipo: objeto FirelensConfiguration

Obligatorio: no

La FireLens configuración del contenedor. Esto se utiliza para especificar y configurar un enrutador de registro para registros de contenedores. Para obtener más información, consulte Uso del enrutamiento de registros personalizado.


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

options

Tipo: mapa de cadena a cadena

Obligatorio: no

Las opciones de asignación de clave/valor que se deben usar al configurar el enrutador de registros. Este campo es opcional y se puede utilizar para especificar un archivo de configuración personalizado o agregar metadatos adicionales, como la tarea, la definición de tareas, el clúster y detalles de la instancia de contenedor al evento de registro. Si se especifica, la sintaxis que se va a utilizar es "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}. Para obtener más información, consulte Especificar una FireLens configuración en una definición de tarea.

type

Tipo: cadena

Obligatorio: sí

El router de registros que se va a utilizar. Los valores válidos son fluentd o fluentbit.

Seguridad

Para obtener más información sobre la seguridad del contenedor, consulte Task and container security (Seguridad de las tareas y los contenedores) en la Guía de prácticas recomendadas de Amazon ECS.

credentialSpecs

Tipo: matriz de cadenas

Obligatorio: 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.

Especificación de credenciales sin dominio: MyARN

Utiliza credentialspecdomainless:MyARN para proporcionar a la CredSpec una sección adicional para un secreto en Secrets Manager. Proporciona las credenciales de inicio de sesión al dominio en el secreto.

Cada tarea que se ejecute en cualquier instancia de contenedor puede unirse a diferentes dominios.

Puede utilizar este formato sin unir la instancia de contenedor a un dominio.

Especificación de credenciales: MyARN

Utiliza credentialspec:MyARN para proporcionar una CredSpec para un solo dominio.

Debe unir la instancia de contenedor al dominio antes de iniciar cualquier tarea que utilice esta definición de tarea.

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.

privileged

Tipo: Booleano

Obligatorio: 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 asigna a Privileged en la sección Crear un contenedor de la API remota de Docker y con la opción --privileged de docker run.

nota

Este parámetro no es compatible con contenedores Windows o tareas con el tipo de lanzamiento Fargate.

El valor predeterminado es false.


"privileged": true|false

user

Tipo: cadena

Requerido: no

El usuario que se utiliza dentro del contenedor. Este parámetro se asigna a User en la sección Crear un contenedor de la API remota de Docker y con la opción --user de docker run.

importante

Al ejecutar tareas que utilizan el modo de red de host, no debe ejecutar contenedores con el usuario raíz (UID 0). Como práctica recomendada de seguridad, utilice siempre un usuario que no sea usuario raíz.

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

user
user:group
uid
uid:gid
user:gid
uid:group

nota

Este parámetro no es compatible con contenedores Windows.


"user": "string"

dockerSecurityOptions

Tipo: matriz de cadenas

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

Obligatorio: no

Una lista de cadenas para proporcionar una configuración personalizada para varios sistemas de seguridad. Para obtener más información acerca de los valores válidos, vea Docker Run Security Configuration. 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 Uso de GMSA para contenedores de Windows en Amazon EC2 y Uso gMSA para Linux contenedores en Amazon EC2.

Este parámetro se asigna a SecurityOpt en la sección Crear un contenedor de la API remota de Docker y con la opción --security-opt de docker.


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

nota

El agente de contenedor de Amazon ECS que se ejecuta en una instancia de contenedor se debe registrar con las variables de entorno ECS_SELINUX_CAPABLE=true o ECS_APPARMOR_CAPABLE=true antes de que los contenedores situados en dicha instancia puedan utilizar estas opciones de seguridad. Para obtener más información, consulte Configuración del agente de contenedor de Amazon ECS.

Límites de recursos

ulimits

Tipo: matriz de objetos

Obligatorio: 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 asigna a Ulimits en la sección Crear un contenedor de la API remota de Docker y con la opción --ulimit de 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 1024 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.

nota

Este parámetro no es compatible con contenedores Windows.


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

name

Tipo: cadena

Obligatorio: sí, si se utilizan ulimits.

El valor type de ulimit.

hardLimit

Tipo: entero

Obligatorio: sí, si se utilizan ulimits.

El límite máximo para el tipo de ulimit.

softLimit

Tipo: entero

Obligatorio: sí, si se utilizan ulimits.

El límite flexible para el tipo de ulimit.

Etiquetas de Docker

dockerLabels

Tipo: mapa de cadena a cadena

Obligatorio: no

Un mapa de clave/valor de etiquetas que agregar al contenedor. Este parámetro se asigna a Labels en la sección Crear un contenedor de la API remota de Docker y con la opción --label de 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"
      ...}

Otros parámetros de definición de contenedor

Los siguientes parámetros de definición de contenedor se pueden utilizar al registrar definiciones de tareas en la consola de Amazon ECS mediante la opción Configure via JSON (Configurar mediante JSON). Para obtener más información, consulte Creación de una definición de tareas con la consola.

Temas

Parámetros de Linux
Dependencia de contenedor
Tiempos de espera de contenedor
Controles del sistema
Interactivo
Pseudoterminal

Parámetros de Linux

linuxParameters

Tipo: objeto LinuxParameters

Obligatorio: no

Linux-opciones específicas que se aplican al contenedor, como. KernelCapabilities

nota

Este parámetro no es compatible con los contenedores de Windows.


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

capabilities

Tipo: objeto KernelCapabilities

Obligatorio: no

Las capacidades de Linux para el contenedor que se agregan a la configuración predeterminada proporcionada por Docker o se eliminan de ella. Para obtener más información sobre las capacidades predeterminadas y las otras capacidades disponibles, consulte Privilegio de tiempo de ejecución y capacidades de Linux en la Referencia de ejecución de Docker. Para obtener más información sobre estas capacidades de Linux, consulte la página del manual de Linux sobre capacidades(7).

add

Tipo: matriz de cadenas

Obligatorio: no

Las capacidades de Linux para el contenedor que se deben añadir a la configuración predeterminada proporcionada por Docker. Este parámetro se corresponde con CapAdd en la sección Crear un contenedor de la API remota de Docker y la opción --cap-add se corresponde con docker run.

nota

Las tareas lanzadas en Fargate solo admiten la adición de la capacidad del kernel SYS_PTRACE.

add

Tipo: matriz de cadenas

Valores válidos: "SYS_PTRACE"

Obligatorio: no

Las capacidades de Linux para el contenedor que se deben agregar a la configuración predeterminada proporcionada por Docker. Este parámetro se corresponde con CapAdd en la sección Crear un contenedor de la API remota de Docker y la opción --cap-add se corresponde con docker run.

drop

Tipo: matriz de cadenas

Obligatorio: no

Las capacidades de Linux para el contenedor que se deben eliminar de la configuración predeterminada proporcionada por Docker. Este parámetro se corresponde con CapDrop en la sección Crear un contenedor de la API remota de Docker y la opción --cap-drop se corresponde con docker run.

devices

Cualquier dispositivo host que exponer en el contenedor. Este parámetro se corresponde con Devices en la sección Crear un contenedor de la API remota de Docker y la opción --device se corresponde con docker run.

nota

El parámetro devices no se admite cuando se utiliza el tipo de lanzamiento de Fargate o contenedores de Windows.

Tipo: matriz de objetos Dispositivo

Obligatorio: no

hostPath

La ruta del dispositivo de la instancia de contenedor del host.

Tipo: cadena

Obligatorio: sí

containerPath

La ruta dentro del contenedor en la cual exponer el dispositivo host.

Tipo: cadena

Requerido: no

permissions

Los permisos explícitos que proporcionar al contenedor para el dispositivo. De forma predeterminada, el contenedor tiene permisos para read, write y mknod en el dispositivo.

Tipo: matriz de cadenas

Valores válidos: read | write | mknod

initProcessEnabled

Ejecute un proceso init dentro del contenedor que reenvíe señales y aproveche procesos. Este parámetro se corresponde con la opción --init de docker run.

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

maxSwap

La cantidad total de memoria de intercambio (en MiB) que puede utilizar un contenedor. Este parámetro se traduce en la opción --memory-swap de docker run donde el valor es la suma de la memoria del contenedor más el valor de maxSwap.

Si se especifica un valor maxSwap para 0, el contenedor no utiliza el intercambio. Los valores aceptados son 0 o cualquier entero positivo. Si se omite el parámetro maxSwap, el contenedor utiliza la configuración de intercambio de la instancia de contenedor en la que se está ejecutando. Debe establecerse un valor de maxSwap para el parámetro swappiness.

nota

Si utiliza tareas que emplean el tipo de lanzamiento de Fargate, no se admite el parámetro maxSwap.

sharedMemorySize

El valor del tamaño (en MiB) del volumen /dev/shm. Este parámetro se corresponde con la opción --shm-size de docker run.

nota

Si utiliza tareas que emplean el tipo de lanzamiento de Fargate, no se admite el parámetro sharedMemorySize.

Tipo: entero

swappiness

Puede utilizar este parámetro para ajustar el comportamiento de intercambio de memoria de un contenedor. Un valor swappiness de 0 evita que se produzca el intercambio a menos que sea necesario. Un valor swappiness de 100 hace que las páginas se intercambien con frecuencia. Los valores aceptados son números enteros comprendidos entre 0 y 100. Si no especifica un valor, se utiliza el valor predeterminado de 60. Además, si no se especifica un valor para maxSwap, este parámetro se omite. Este parámetro se corresponde con la opción --memory-swappiness de docker run.

nota

Si utiliza tareas que emplean el tipo de lanzamiento de Fargate, no se admite el parámetro swappiness.

Si utiliza tareas en Amazon Linux 2023, no se admite el parámetro swappiness.

tmpfs

La ruta del contenedor, las opciones de montaje y el tamaño máximo (en MiB) del montaje tmpfs. Este parámetro se corresponde con la opción --tmpfs de docker run.

nota

Si utiliza tareas que emplean el tipo de lanzamiento de Fargate, no se admite el parámetro tmpfs.

Tipo: matriz de objetos Tmpfs

Obligatorio: no

containerPath

La ruta de archivo absoluta en la que se montará el volumen tmpfs.

Tipo: cadena

Obligatorio: sí

mountOptions

La lista de opciones de montaje del volumen tmpfs.

Tipo: matriz de cadenas

Obligatorio: no

size

El tamaño máximo (en MiB) del volumen tmpfs.

Tipo: entero

Obligatorio: sí

Dependencia de contenedor

dependsOn

Tipo: matriz de objetos ContainerDependency

Obligatorio: 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.

nota

Si un contenedor no cumple una restricción de dependencia o agota el tiempo de espera antes de cumplir la restricción, Amazon ECS no adelanta los contenedores dependientes a su siguiente estado.

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 optimizada 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"
    }
]

containerName

Tipo: cadena

Obligatorio: sí

El nombre del contenedor que debe cumplir la condición especificada.

condition

Tipo: cadena

Obligatorio: sí

La condición de dependencia del contenedor. Están disponibles las siguientes condiciones y su comportamiento:

START: esta condición simula el comportamiento de enlaces y volúmenes en la actualidad. La condición valida que un contenedor dependiente se inicia antes de permitir que se inicien otros contenedores.
COMPLETE: esta condición valida que un contenedor dependiente se ejecute hasta su finalización (se cierre) antes de permitir que otros contenedores se inicien. Esto puede resultar útil para contenedores no esenciales que ejecutan un script y, a continuación, se cierran. Esta condición no se puede establecer en un contenedor esencial.
SUCCESS: esta condición es la misma que COMPLETE, pero además requiere que el contenedor se cierre con un estado zero. Esta condición no se puede establecer en un contenedor esencial.
HEALTHY: esta condición valida que el contenedor dependiente pase su comprobación de estado de contenedor antes de permitir que otros contenedores se inicien. Esto requiere que el contenedor dependiente tenga configuradas las comprobaciones de estado en la definición de tarea. Esta condición solo se confirma durante el inicio de tarea.

Tiempos de espera de contenedor

startTimeout

Tipo: entero

Obligatorio: 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.

nota

Si un contenedor no cumple una restricción de dependencia o agota el tiempo de espera antes de cumplir la restricción, Amazon ECS no adelanta los contenedores dependientes a su siguiente estado.

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.

stopTimeout

Tipo: entero

Obligatorio: 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 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 optimizada para Amazon ECS.

Controles del sistema

systemControls

Tipo: objeto SystemControl

Obligatorio: no

Una lista de los parámetros del núcleo del espacio de nombres para configurarlos en el contenedor. Este parámetro se asigna a Sysctls en la sección Crear un contenedor de la API remota de Docker y con la opción --sysctl de 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:

En las tareas que utilicen el modo de red awsvpc, incluido Fargate, si establece systemControls en cualquier contenedor, esto se aplicará a todos los contenedores de la tarea. Si establece diferentes parámetros systemControls para varios contenedores en una sola tarea, el contenedor que se inicie en último lugar determinará qué systemControls se aplicará.
Para las tareas que utilizan el modo de red host, no se admiten los systemControls del espacio de nombres de la red.

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.

Para las tareas que usan el modo de IPC host, no se admiten los systemControls del espacio de nombres IPC.
Para las tareas que utilizan el modo de IPC task, los valores de systemControls del espacio de nombres IPC se aplican a todos los contenedores de una tarea.

nota

Este parámetro no es compatible con contenedores Windows.

nota

Este parámetro solo se admite para las tareas que están alojadas en AWS Fargate si utilizan la versión de la plataforma 1.4.0 o una posterior (Linux). Este parámetro no es compatible con contenedores de Windows en Fargate.


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

namespace

Tipo: cadena

Requerido: no

El parámetro del núcleo del espacio de nombres para el que se va a establecer un. value

Valores de espacio de nombres de red válidos: Sysctls que comience por "net.*"

Todos estos valores son compatibles con Fargate.

value

Tipo: cadena

Requerido: no

El valor del parámetro del núcleo del espacio de nombres que se especifica en. namespace

Interactivo

interactive

Tipo: Booleano

Obligatorio: 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 asigna a OpenStdin en la sección Crear un contenedor de la API remota de Docker y con la opción --interactive de docker run.

El valor predeterminado es false.

Pseudoterminal

pseudoTerminal

Tipo: Booleano

Obligatorio: no

Cuando este parámetro es true, se asigna un TTY. Este parámetro se asigna a Tty en la sección Crear un contenedor de la API remota de Docker y con la opción --tty de docker run.

El valor predeterminado es false.

Nombre del acelerador de Elastic Inference

nota

A partir del 15 de abril de 2023, no AWS incorporará nuevos clientes a Amazon Elastic Inference (EI) y ayudará a los clientes actuales a migrar sus cargas de trabajo a opciones que ofrezcan mejores precios y rendimiento. Después del 15 de abril de 2023, los nuevos clientes no podrán lanzar instancias con los aceleradores de Amazon EI en Amazon SageMaker, Amazon ECS o Amazon EC2. Sin embargo, los clientes que hayan utilizado Amazon EI al menos una vez durante los últimos 30 días se consideran clientes actuales y podrán seguir utilizando el servicio.

El requisito de recursos del acelerador de Elastic Inference para la definición de tareas. Para obtener más información, consulte ¿Qué es Amazon Elastic Inference? en la Guía para desarrolladores de Amazon Elastic Inference.

Los siguientes parámetros están permitidos en una definición de tarea:

deviceName

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.

deviceType

Tipo: cadena

Obligatorio: sí

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

Restricciones para ubicación de tareas

Cuando se registra una definición de tareas, se pueden proporcionar restricciones de ubicación de tareas que personalizan la forma en la que Amazon ECS las coloca.

Si utiliza el tipo de lanzamiento de Fargate, no se admiten las restricciones de ubicación de tareas. De forma predeterminada, las tareas de Fargate se reparten entre las zonas de disponibilidad.

Para las tareas que usan el tipo de lanzamiento EC2, se pueden usar restricciones para colocar tareas en función de la zona de disponibilidad, el tipo de instancia o atributos personalizados. Para obtener más información, consulte Defina qué instancias de contenedor utiliza Amazon ECS para las tareas.

Los siguientes parámetros están permitidos en una definición de contenedor:

expression

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 Cree expresiones para definir instancias de contenedor para las tareas de Amazon ECS.

type

Tipo: cadena

Obligatorio: sí

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

Configuración del proxy

proxyConfiguration

Tipo: objeto ProxyConfiguration

Obligatorio: 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 optimizada 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.

nota

Este parámetro no es compatible con contenedores Windows.


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

type

Tipo: cadena

Valores válidos: APPMESH

Obligatorio: no

El tipo de proxy. El único valor admitido es APPMESH.

containerName

Tipo: cadena

Obligatorio: sí

El nombre del contenedor que sirve como proxy de App Mesh.

properties

Tipo: matriz de objetos KeyValuePair

Obligatorio: no

El conjunto de parámetros de configuración de red para proporcionar el complemento Container Network Interface (CNI), especificado como pares clave-valor.

IgnoredUID: (obligatorio) el ID de usuario (UID) del contenedor proxy tal y como lo define el parámetro user en una definición de contenedor. Se utiliza para garantizar que el proxy pasa por alto su propio tráfico. Si se especifica IgnoredGID, este campo puede estar vacío.
IgnoredGID: (obligatorio) el ID de grupo (GID) del contenedor proxy tal y como lo define el parámetro user en una definición de contenedor. Se utiliza para garantizar que el proxy pasa por alto su propio tráfico. Si se especifica IgnoredUID, este campo puede estar vacío.
AppPorts: (obligatorio) la lista de los puertos que utiliza la aplicación. El tráfico de red hacia estos puertos se reenvía a ProxyIngressPort y ProxyEgressPort.
ProxyIngressPort: (obligatorio) especifica el puerto al que se dirige el tráfico que ingresa a AppPorts.
ProxyEgressPort: (obligatorio) especifica el puerto al que se dirige el tráfico que sale de AppPorts.
EgressIgnoredPorts: (obligatorio) el tráfico de salida que se dirige a estos puertos especificados se pasa por alto y no se redirige a ProxyEgressPort. Puede ser una lista vacía.
EgressIgnoredIPs: (obligatorio) el tráfico de salida que se dirige a estas direcciones IP especificadas se pasa por alto y no se redirige a ProxyEgressPort. Puede ser una lista vacía.

name

Tipo: cadena

Requerido: no

El nombre del par clave-valor.

value

Tipo: cadena

Requerido: no

El valor del par clave-valor.

Volúmenes

Al registrar una definición de tarea, si lo desea, puede especificar una lista de volúmenes para pasarlos al Docker daemon en una instancia de contenedor, que luego estará disponible para el acceso de otros contenedores de la misma instancia de contenedor.

A continuación se indican los tipos de volúmenes de datos que se pueden usar:

Volúmenes de Amazon EBS: proporciona almacenamiento en bloques rentable, duradero y de alto rendimiento para cargas de trabajo en contenedores con uso intensivo de datos. Puede adjuntar 1 volumen de Amazon EBS por tarea de Amazon ECS cuando ejecute una tarea independiente o cuando cree o actualice un servicio. Los volúmenes de Amazon EBS son compatibles con las tareas de Linux alojadas en instancias de Fargate o Amazon EC2. Para obtener más información, consulte Volúmenes de Amazon EBS.
Volúmenes de Amazon EFS: proporciona almacenamiento de archivos sencillo, escalable y persistente para usarlo con tareas de Amazon ECS. Con Amazon EFS, la capacidad de almacenamiento es elástica. Aumenta y disminuye automáticamente a medida que se agregan o eliminan archivos. Sus aplicaciones disponen del almacenamiento que necesitan, cuando lo necesitan. Se admiten volúmenes de Amazon EFS para tareas que están alojadas en instancias de Fargate o Amazon EC2. Para obtener más información, consulte Volúmenes de Amazon EFS.
Volúmenes de FSx for Windows File Server: proporciona servidores de archivos de Microsoft Windows completamente administrados. Estos servidores de archivos están respaldados por un sistema de archivos de Windows. Cuando utiliza FSx for Windows File Server junto con Amazon ECS, puede aprovisionar sus tareas de Windows con almacenamiento persistente, distribuido, compartido y estático de archivos. Para obtener más información, consulte Volúmenes de FSx for Windows File Server.

Los contenedores Windows de Fargate no admiten esta opción.
Volúmenes de Docker: un volumen administrado por Docker que se crea en la instancia host de /var/lib/docker/volumes Amazon EC2. Los controladores de volúmenes de Docker (también llamados complementos) se usan para integrar los volúmenes con sistemas de almacenamiento externos como Amazon EBS. Se puede usar el controlador de volumen local integrado o un controlador de volumen de terceros. Los volúmenes de Docker solo se admiten cuando se ejecutan tareas en instancias de Amazon EC2. Los contenedores de Windows solo admiten el uso del local controlador. Para utilizar volúmenes de Docker, especifique dockerVolumeConfiguration en su definición de tarea. Para obtener más información, consulte Uso de volúmenes.
Montajes encuadernados: un archivo o directorio de la máquina host que se monta en un contenedor. Los volúmenes de host de montaje en enlace se admiten cuando se ejecutan tareas en instancias de AWS Fargate o Amazon EC2. Para utilizar volúmenes de host de montaje vinculado, especifique host y un valor de sourcePath opcional en su definición de tarea. Para obtener más información, consulte la página sobre el uso de montajes vinculados.

Para obtener más información, consulte Uso de volúmenes de datos en tareas.

Los siguientes parámetros están permitidos en una definición de contenedor.

name

Tipo: cadena

Requerido: no

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

host

Obligatorio: 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.

nota

El sourcePath parámetro solo se admite cuando se utilizan tareas alojadas en instancias de Amazon EC2.

sourcePath

Tipo: cadena

Requerido: no

Cuando utilice el parámetro host, especifique una sourcePath para declarar la ruta de la instancia de Amazon EC2 del host que se presenta al contenedor. Si este parámetro está vacío, el daemon de Docker asigna una ruta de host. Si el parámetro host contiene una ubicación de archivos sourcePath, el volumen de datos persiste en la ubicación especificada en la instancia de Amazon EC2 del host hasta que la elimine manualmente. Si el valor sourcePath no existe en la instancia de Amazon EC2 del host, el daemon de Docker lo crea. Si la ubicación existe, el contenido de la carpeta de la ruta de origen se exporta.

configuredAtLaunch

Tipo: Booleano

Obligatorio: no

Especifica si un volumen se puede configurar en el momento del lanzamiento. Si se establece entrue, puede configurar el volumen al ejecutar una tarea independiente o al crear o actualizar un servicio. Si está configurado entrue, no podrá proporcionar otra configuración de volumen en la definición de la tarea. Este parámetro debe configurarse true para configurar un volumen de Amazon EBS para adjuntarlo a una tarea. Establecer configuredAtLaunch true y aplazar la configuración del volumen hasta la fase de lanzamiento le 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 volver a utilizar en distintos entornos de ejecución. Para obtener más información, consulte Volúmenes de Amazon EBS.

dockerVolumeConfiguration

Tipo: DockerVolumeConfigurationobjeto

Obligatorio: no

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

scope

Tipo: cadena

Valores válidos: task | shared

Obligatorio: no

El ámbito del volumen de Docker, que determina su ciclo de vida. Los volúmenes de Docker con un ámbito de task se aprovisionan automáticamente cuando se inicia la tarea y se destruyen cuando la tarea se detiene. Los volúmenes de Docker cuyo ámbito es shared se conservan una vez detenida la tarea.

autoprovision

Tipo: Booleano

Valor predeterminado: false

Obligatorio: no

Si este valor es true, el volumen de Docker se crea si aún no existe. Este campo solo se usa si scope esshared. Si scope estask, este parámetro se debe omitir o establecer false en.

driver

Tipo: cadena

Requerido: no

El controlador del volumen de Docker que se va a usar. El valor del controlador debe coincidir con el nombre del controlador proporcionado por Docker, ya que este nombre se utiliza para la colocación de tareas. Si el controlador se instaló mediante la CLI del complemento Docker, utilícelo docker plugin ls para recuperar el nombre del controlador de la instancia de contenedor. Si el controlador se instaló mediante otro método, utilice Docker Plugin Discovery para recuperar el nombre del controlador. Para obtener más información, consulte la documentación sobre la detección de complementos de Docker. Este parámetro se asigna a Driver en la sección Create a volume (Crear un volumen) de la Docker Remote API (API remota de Docker) y con la opción de --driver para docker volume create.

driverOpts

Tipo: cadena

Requerido: no

Un mapa con las opciones específicas de los controladores de Docker para consultarlas. Este parámetro se asigna a DriverOpts en la sección Create a volume (Crear un volumen) de la Docker Remote API (API remota de Docker) y con la opción de --opt para docker volume create.

labels

Tipo: cadena

Requerido: no

Metadatos personalizados que se añaden al volumen de Docker. Este parámetro se asigna a Labels en la sección Create a volume (Crear un volumen) de la Docker Remote API (API remota de Docker) y con la opción de --label para docker volume create.

efsVolumeConfiguration

Tipo: VolumeConfiguration Objeto EFS

Obligatorio: no

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

fileSystemId

Tipo: cadena

Obligatorio: sí

El ID del sistema de archivos de Amazon EFS que se va a usar.

rootDirectory

Tipo: cadena

Obligatorio: no

Directorio del sistema de archivos de Amazon EFS que se va a montar como directorio raíz dentro del host. Si se omite este parámetro, se utilizará la raíz del volumen de Amazon EFS. Si se especifica /, se obtiene el mismo efecto que si se omite este parámetro.

importante

Si se especifica un punto de acceso EFS enauthorizationConfig, el parámetro del directorio raíz debe omitirse o establecerse en/, lo que aplicará la ruta establecida en el punto de acceso EFS.

transitEncryption

Tipo: cadena

Valores válidos: ENABLED | DISABLED

Obligatorio: no

Especifica si se habilita el cifrado para los datos en tránsito de Amazon EFS entre el host de Amazon ECS y el servidor de Amazon EFS. Si se utiliza la autorización de IAM en Amazon EFS, el cifrado en tránsito debe estar habilitado. Si se omite este parámetro, se usa el valor predeterminado de DISABLED. Para obtener más información, consulte Cifrado de datos en tránsito en la Guía del usuario de Amazon Elastic File System.

transitEncryptionPort

Tipo: entero

Obligatorio: no

El puerto que se utilizará al enviar datos cifrados entre el host de Amazon ECS y el servidor de Amazon EFS. Si no especifica un puerto de cifrado de tránsito, la tarea utilizará la estrategia de selección de puertos que utiliza el asistente de montaje de Amazon EFS. Para obtener más información, consulte Ayudante de montaje de EFS en la Guía del usuario de Amazon Elastic File System.

authorizationConfig

Tipo: AuthorizationConfiguration Objeto EFS

Obligatorio: no

Los detalles de configuración de autorización en el sistema de archivos de Amazon EFS.

accessPointId

Tipo: cadena

Requerido: no

ID de punto de acceso que se va a utilizar. Si se especifica un punto de acceso, el valor del directorio raíz en el efsVolumeConfiguration debe omitirse o establecerse en/, lo que aplicará la ruta establecida en el punto de acceso EFS. Si se utiliza un punto de acceso, el cifrado de tránsito debe estar habilitado en el EFSVolumeConfiguration. Para obtener más información, consulte Trabajo con puntos de acceso de Amazon EFS en la Guía del usuario de Amazon Elastic File System.

iam

Tipo: cadena

Valores válidos: ENABLED | DISABLED

Obligatorio: no

Especifica si se debe utilizar la función de IAM de tareas de Amazon ECS que se define en una definición de tarea al montar el sistema de archivos de Amazon EFS. Si está habilitado, el cifrado de tránsito debe estar habilitado en el EFSVolumeConfiguration. Si se omite este parámetro, se usa el valor predeterminado de DISABLED. Para obtener más información, consulte Roles de IAM para las tareas.

FSxWindowsFileServerVolumeConfiguration

Tipo: objeto F SxWindowsFileServerVolumeConfiguration

Obligatorio: sí

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

fileSystemId

Tipo: cadena

Obligatorio: sí

ID del sistema de archivos FSx for Windows File Server que se va a utilizar.

rootDirectory

Tipo: cadena

Obligatorio: sí

Directorio dentro del sistema de archivos de FSx for Windows File Server que se va a montar como directorio raíz dentro del host.

authorizationConfig

credentialsParameter

Tipo: cadena

Obligatorio: sí

Opciones de credenciales de autorización.

opciones:

Nombre de recurso de Amazon (ARN) de un AWS Secrets Managersecreto.
ARN de un AWS Systems Managerparámetro.

domain

Tipo: cadena

Obligatorio: sí

Un nombre de dominio totalmente cualificado alojado en un directorio AWS Directory Service for Microsoft Active Directory(AWS Managed Microsoft AD) o en un Active Directory EC2 autohospedado.

Etiquetas

Cuando se registra una definición de tareas, se pueden especificar etiquetas de metadatos que se aplican a la definición de tareas. Las etiquetas ayudan a clasificar y organizar la definición de tareas. Cada etiqueta consta de una clave y un valor opcional. Los define a los dos. Para obtener más información, consulte Etiquetado de recursos de Amazon ECS.

importante

No agregue información de identificación personal ni otra información confidencial en las etiquetas. Muchos AWS servicios, incluida la facturación, pueden acceder a las etiquetas. Las etiquetas no se diseñaron para utilizarse con información privada o confidencial.

Los siguientes parámetros se admiten en un objeto de etiqueta.

key

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.

value

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).

Otros parámetros de definición de tarea

Los siguientes parámetros de definición de tareas se pueden utilizar cuando se registran definiciones de tareas en la consola de Amazon ECS mediante la opción Configure via JSON (Configurar mediante JSON). Para obtener más información, consulte Creación de una definición de tareas con la consola.

Temas

Almacenamiento efímero
Modo IPC
Modo PID

Almacenamiento efímero

ephemeralStorage

Tipo: objeto EphemeralStorage

Obligatorio: 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 Montajes de enlace.

nota

Este parámetro solo se admite para las tareas que están alojadas en AWS Fargate que utilizan la versión de la plataforma 1.4.0 o una posterior (Linux) o 1.0.0 o una posterior (Windows).

Modo IPC

ipcMode

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. Para obtener más información, consulte IPC settings en la Referencia de ejecución de Docker.

Si se utiliza el modo de IPC host, existe un mayor riesgo de exposición de espacio de nombres de IPC no deseada. Para obtener más información, consulte Docker security.

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. Para obtener más información, consulte Controles del sistema.

Para las tareas que utilizan el modo de IPC host, no se admiten los systemControls relacionados con el espacio de nombres de IPC.
Para las tareas que utilizan el modo de IPC task, los systemControls relacionados con el espacio de nombres de IPC se aplican a todos los contenedores de una tarea.

nota

Este parámetro no es compatible con contenedores Windows o tareas con el tipo de lanzamiento Fargate.

Modo PID

pidMode

Tipo: cadena

Valores válidos: host | task

Obligatorio: 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. Para obtener más información, consulte PID settings en la Referencia de ejecución de Docker.

Si se utiliza el modo de PID host, existe un mayor riesgo de exposición de espacio de nombres del proceso no deseada. Para obtener más información, consulte Docker security.

nota

Este parámetro no es compatible con contenedores Windows.

nota

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Referencias de parámetros y plantillas de recursos

Plantilla de definición de tareas