Paramètres de définition de tâche Amazon ECS pour Amazon EC2

Type : String

Obligatoire : oui

Lorsque vous enregistrez une définition de tâche, vous lui attribuez une famille. Cela équivaut, pour plusieurs versions de définition de tâche, à lui attribuer un nom spécifié avec un numéro de révision. La première définition de tâche enregistrée dans une famille donnée reçoit le numéro de révision 1. Toute définition de tâche enregistrée après celle-ci reçoit un numéro de révision ultérieur dans l'ordre séquentiel.

Type : tableau de chaînes

Obligatoire : non

Valeurs valides : EC2

La capacité par rapport à laquelle valider la définition de tâche. Une vérification est alors lancée afin de s’assurer que tous les paramètres utilisés dans la définition de tâche répondent aux exigences d’Amazon EC2.

Type : chaîne

Obligatoire : non

Lorsque vous enregistrez une définition de tâche, vous pouvez fournir un rôle de tâche pour un rôle IAM qui permet aux conteneurs dans l'autorisation de tâche d'appeler en votre nom les API AWS qui sont spécifiées dans les stratégies qui lui associées. Pour de plus amples informations, consultez rôle IAM de tâche Amazon ECS.

Lorsque vous lancez l'AMI Windows Server optimisée pour Amazon ECS, les rôles IAM pour les tâches sous Windows nécessitent que l'option -EnableTaskIAMRole soit définie. Vos conteneurs doivent également exécuter certains codes de configuration afin d'utiliser la fonctionnalité. Pour de plus amples informations, consultez Configuration supplémentaire d’instance Windows Amazon EC2.

Type : String

Obligatoire : Conditionnelle

Amazon Resource Name (ARN) du rôle d'exécution de tâche qui accorde à l'agent de conteneur Amazon ECS l'autorisation d'effectuer des appels d'API AWS en votre nom.

Type : chaîne

Obligatoire : non

Mode réseau Docker à utiliser pour les conteneurs de la tâche. Pour les tâches Amazon ECS hébergées sur des instances Linux Amazon EC2, les valeurs valides sont none, bridge, awsvpc et host. Si aucun mode réseau n’est spécifié, le mode réseau par défaut est bridge. Pour les tâches Amazon ECS hébergées sur des instances Windows Amazon EC2, les valeurs valides sont default et awsvpc. Si aucun mode réseau n’est spécifié, le mode réseau default est utilisé.

Si le mode réseau est défini sur none, les conteneurs de la tâche ne disposent d'aucune connectivité externe et les mappages de ports ne peuvent pas être spécifiés dans la définition du conteneur.

Si le mode réseau est bridge, la tâche utilise le réseau virtuel intégré de Docker sous Linux, qui s'exécute à l'intérieur de chaque instance Amazon EC2 hébergeant la tâche. Le réseau virtuel intégré sous Linux utilise le pilote réseau Docker bridge.

Si le mode réseau est host, la tâche utilise le réseau de l'hôte qui contourne le réseau virtuel intégré de Docker en mappant les ports de conteneur directement à l'ENI de l'instance Amazon EC2 qui héberge la tâche. Les mappages de ports dynamiques ne peuvent pas être utilisés dans ce mode réseau. Dans une définition de tâche qui utilise ce mode, un conteneur doit spécifier un numéro hostPort spécifique. Un numéro de port sur un hôte ne peut pas être utilisé par plusieurs tâches. Dans ce mode, vous ne pouvez pas exécuter plusieurs tâches de la même définition de tâche sur une instance Amazon EC2 unique.

Si le mode réseau est awsvpc, une interface réseau Elastic est attribuée à la tâche, et vous devez spécifier une configuration NetworkConfiguration lorsque vous créez un service ou exécutez une tâche avec la définition de tâche. Pour de plus amples informations, consultez Options de mise en réseau des tâches Amazon ECS pour EC2.

Si le mode réseau est default, la tâche utilise le réseau virtuel intégré de Docker sous Windows, qui s'exécute à l'intérieur de chaque instance Amazon EC2 hébergeant la tâche. Le réseau virtuel intégré sous Windows utilise le pilote réseau Docker nat.

Les modes réseau host et awsvpc offrent les meilleures performances de mise en réseau pour les conteneurs, car ils utilisent la pile de réseau Amazon EC2. Avec les modes réseau host et awsvpc, les ports de conteneur exposés sont mappés directement au port hôte correspondant (pour le mode réseau hôte host) ou au port de l'interface réseau Elastic (pour le mode réseau awsvpc). Pour cette raison, vous ne pouvez pas utiliser de mappages de ports hôtes dynamiques.

Le mode réseau autorisé dépend du système d’exploitation de l’instance EC2 sous-jacente. Sous Linux, n'importe quel mode réseau peut être utilisé. S'il s'agit de Windows, les modes default et awsvpc peuvent être utilisés.

Type : String

Obligatoire : Conditionnelle

Par défaut : LINUX

Lorsque vous enregistrez une définition de tâche, vous spécifiez la famille du système d'exploitation.

Les valeurs valides sont LINUX, WINDOWS_SERVER_2025_FULL, WINDOWS_SERVER_2025_CORE, WINDOWS_SERVER_2022_CORE, WINDOWS_SERVER_2022_FULL, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2016_FULL, WINDOWS_SERVER_2004_CORE et WINDOWS_SERVER_20H2_CORE.

Toutes les définitions de tâches qui sont utilisées dans un service doivent avoir la même valeur pour ce paramètre.

Lorsqu'une définition de tâche fait partie d'un service, cette valeur doit correspondre à la valeur platformFamily du service.

Type : String

Obligatoire : Conditionnelle

Par défaut : X86_64

Lorsque vous enregistrez une définition de tâche, vous spécifiez l'architecture du processeur. Les valeurs valides sont X86_64 et ARM64.

Toutes les définitions de tâches qui sont utilisées dans un service doivent avoir la même valeur pour ce paramètre.

Lorsque vous avez des tâches Linux, vous pouvez définir la valeur sur ARM64. Pour de plus amples informations, consultez Définitions de tâche Amazon ECS pour les charges de travail ARM 64 bits.

Type : String

Obligatoire : Conditionnelle

Limite stricte du nombre d'unités UC à présenter pour la tâche. Vous pouvez spécifier les valeurs de l’UC dans le fichier JSON sous forme de chaîne en unités d’UC ou en processeurs virtuels (vCPU). Par exemple, vous pouvez spécifier une valeur d’UC de 1024 en unités d’UC ou de 1 vCPU en vCPU. Lorsque la définition de tâche est enregistrée, la valeur de vCPU (processeurs virtuels) est convertie en un nombre entier indiquant les unités UC.

Ce champ est facultatif. Si votre cluster n'a pas d'instances de conteneur enregistrées avec les unités UC demandées disponibles, la tâche échouera. Les valeurs prises en charge se situent entre 0.125 vCPU et 192 vCPU.

Type : String

Obligatoire : Conditionnelle

Limite stricte de quantité de mémoire à allouer à la tâche. Vous pouvez spécifier les valeurs de mémoire dans la définition de la tâche sous forme de chaîne en mébioctets (Mio) ou en gigaoctets (Go). Par exemple, vous pouvez spécifier une valeur de mémoire de 3072 en Mio ou de 3 GB en Go. Lorsque la définition de tâche est enregistrée, la valeur en Go est convertie en un nombre entier indiquant la quantité de Mio.

Ce champ est facultatif et n'importe quelle valeur peut être utilisée. Si une valeur de mémoire au niveau de la tâche est spécifiée, la valeur de mémoire au niveau du conteneur est facultative. Si votre cluster n'a pas d'instances de conteneur enregistrées avec la mémoire demandée disponible, la tâche échoue. Vous pouvez optimiser l'utilisation de vos ressources en fournissant à vos tâches autant de mémoire que possible pour un type d'instance particulier. Pour de plus amples informations, consultez Réservation de mémoire pour une instance de conteneur Amazon ECS Linux.

Type : String

Obligatoire : oui

Le nom d'un conteneur. Il peut comporter jusqu'à 255 lettres (majuscules et minuscules), des chiffres, des tirets ou des traits de soulignement. Si vous associez plusieurs conteneurs dans une définition de tâche, vous pouvez spécifier l'option name d'un conteneur dans l'option links d'un autre conteneur. Cela permet de connecter les conteneurs.

Type : String

Obligatoire : oui

Image utilisée pour démarrer un conteneur. Cette chaîne est transmise directement au démon Docker. Par défaut, les images dans le registre Docker Hub sont disponibles. Vous pouvez également spécifier d'autres référentiels avec soit repository-url/image:tag, soit repository-url/image@digest. Il peut comporter jusqu'à 255 lettres (majuscules et minuscules), des chiffres, des tirets, des traits de soulignement, deux points, des points, des barres obliques et des signes dièse. Ce paramètre correspond à Image dans la commande docker create-container et au paramètre IMAGE de la commande docker run.

Type : String

Valeurs valides : enabled|disabled

Obligatoire : non

Spécifie si Amazon ECS résoudra la balise d’image de conteneur fournie dans la définition du conteneur en un condensé d’image. Par défaut, ce comportement est enabled. Si vous définissez la valeur d’un conteneur sur disabled, Amazon ECS ne résoudra pas la balise d’image de conteneur en un condensé et utilisera l’URI d’image d’origine spécifiée dans la définition du conteneur pour le déploiement. Pour plus d’informations sur la résolution des images de conteneur, consultez la section Résolution de l'image du conteneur.

Type : entier

Obligatoire : non

La quantité de mémoire (en Mio) à présenter au conteneur. Si votre conteneur tente de dépasser la mémoire spécifiée ici, il sera désactivé. La quantité totale de mémoire réservée pour tous les conteneurs au sein d'une tâche doit être inférieure à la valeur memory de la tâche, si cette valeur est spécifiée. Ce paramètre correspond à Memory dans la commande docker create-container et à l’option --memory dans la commande docker run.

Vous devez spécifier une valeur de mémoire soit au niveau de la tâche, soit au niveau du conteneur. Si vous spécifiez à la fois une valeur de memory au niveau du conteneur et une valeur memoryReservation, la valeur de memory doit être supérieure à celle de memoryReservation. Si vous spécifiez memoryReservation, cette valeur est soustraite des ressources mémoire disponibles pour l'instance de conteneur sur laquelle le conteneur est placé. Sinon, c'est la valeur memory qui est utilisée.

Le démon Docker 20.10.0 ou ultérieur réserve un minimum de 6 Mio de mémoire pour un conteneur. Par conséquent, ne spécifiez pas moins de 6 Mio de mémoire pour vos conteneurs.

Le démon Docker 19.03.13-ce ou antérieur réserve un minimum de 4 Mio de mémoire pour un conteneur. Par conséquent, ne spécifiez pas moins de 4 Mio de mémoire pour vos conteneurs.

Type : entier

Obligatoire : non

La limite flexible (en Mio) de mémoire à réserver pour le conteneur. En cas de contention de la mémoire système, Docker tente de garder la mémoire du conteneur en deçà de cette limite flexible. Toutefois, votre conteneur peut utiliser davantage de mémoire en cas de besoin. Le conteneur peut consommer jusqu'à la limite stricte spécifiée avec le paramètre memory (le cas échéant), ou la totalité de la mémoire disponible sur l'instance de conteneur, selon la première valeur atteinte. Ce paramètre correspond à MemoryReservation dans la commande docker create-container et à l’option --memory-reservation dans la commande docker run.

Si aucune valeur de mémoire au niveau de la tâche n'est spécifiée, vous devez indiquer un nombre entier différent de zéro pour memory ou memoryReservation dans une définition de conteneur. Si vous spécifiez les deux, memory doit être supérieur à memoryReservation. Si vous spécifiez memoryReservation, cette valeur est soustraite des ressources mémoire disponibles pour l'instance de conteneur sur laquelle le conteneur est placé. Sinon, c'est la valeur memory qui est utilisée.

Par exemple, supposons que votre conteneur utilise normalement 128 Mio de mémoire, mais qu'il lui arrive d'utiliser jusqu'à 256 Mio de mémoire pendant de courtes périodes. Vous pouvez définir une memoryReservation de 128 Mio et une limite stricte memory de 300 Mio. Cette configuration permet au conteneur de ne réserver que 128 Mio de mémoire à partir des ressources restantes sur l'instance de conteneur. En même temps, cette configuration permet également au conteneur d'utiliser davantage de ressources mémoire lorsque cela est nécessaire.

Le démon Docker 20.10.0 ou ultérieur réserve un minimum de 6 Mio de mémoire pour un conteneur. Par conséquent, ne spécifiez pas moins de 6 Mio de mémoire pour vos conteneurs.

Le démon Docker 19.03.13-ce ou antérieur réserve un minimum de 4 Mio de mémoire pour un conteneur. Par conséquent, ne spécifiez pas moins de 4 Mio de mémoire pour vos conteneurs.

Type : tableau d'objets

Obligatoire : non

Les mappages de ports exposent les ports réseau de votre conteneur au monde extérieur, ce qui permet aux clients d’accéder à votre application. Ils sont également utilisés pour la communication entre conteneurs au sein d’une même tâche.

Pour les définitions de tâche qui utilisent le mode réseau awsvpc, spécifiez uniquement containerPort. Le hostPort est toujours ignoré et le port du conteneur est automatiquement mappé à un port aléatoire portant un numéro élevé sur l’hôte.

Les mappages de ports sur Windows utilisent l'adresse de passerelle NetNAT plutôt que localhost. Il n'existe aucune boucle pour les mappages de ports sous Windows, donc vous ne pouvez pas accéder au port mappé d'un conteneur à partir de l'hôte lui-même.

La plupart des champs de ce paramètre (y compris containerPort, hostPort, protocol) correspondent à PortBindings dans la commande docker create-container et à l’option --publish de docker run. Si le mode réseau d'une définition de tâche est défini sur host, les ports hôtes doivent être indéfinis ou correspondre au port du conteneur dans le mappage de port.

Si vous spécifiez un port hôte, utilisez la syntaxe suivante.

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

Si vous souhaitez utiliser un port hôte affecté automatiquement, utilisez la syntaxe suivante.

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

Type : objet RepositoryCredentials

Obligatoire : non

Informations d'identification du référentiel pour l'authentification de registre privé.

Pour de plus amples informations, consultez Utilisation d’images de conteneur autre qu’AWS dans Amazon ECS.

La politique de redémarrage du conteneur et les paramètres de configuration associés. Lorsque vous configurez une politique de redémarrage pour un conteneur, Amazon ECS peut redémarrer le conteneur sans avoir à remplacer la tâche. Pour de plus amples informations, consultez Redémarrage de conteneurs individuels dans les tâches Amazon ECS à l’aide de politiques de redémarrage de conteneurs.

Commande de surveillance de l'état du conteneur et paramètres de configuration associés pour le conteneur. Pour de plus amples informations, consultez Determine Amazon ECS task health using container health checks.

Type : entier

Obligatoire : non

Le nombre d'unités cpu que l'agent de conteneur Amazon ECS réserve pour le conteneur. Sous Linux, ce paramètre correspond à CpuShares dans la section Créer un conteneur.

Les conteneurs Linux partagent des unités de processeur non allouées avec les autres conteneurs de l'instance de conteneur selon le même ratio que la quantité allouée. Par exemple, supposons que vous exécutez une tâche à conteneur unique sur un type d'instance à cœur unique avec 512 unités de processeur spécifiées pour ce conteneur. De plus, cette tâche est la seule tâche en cours d'exécution sur l'instance de conteneur. Dans cet exemple, le conteneur peut utiliser le partage complet de 1 024 unités UC à tout moment. Toutefois, supposons que vous ayez lancé une autre copie de la même tâche sur cette instance de conteneur. Un minimum de 512 unités de processeur est affecté à chaque tâche si nécessaire. De même, si l'autre conteneur n'utilise pas le processeur restant, chaque conteneur peut bénéficier d'une utilisation plus importante du processeur. Toutefois, si les deux tâches sont actives à 100 % en permanence, elles sont limitées à 512 unités d'UC.

Sur les instances de conteneur Linux, le démon Docker de l'instance de conteneur se sert de la valeur de processeur pour calculer les ratios de partage de processeur relatifs pour les conteneurs en cours d'exécution. La valeur de parts d’UC minimale autorisée par le noyau Linux est de 2, et la valeur de parts d’UC maximale autorisée par le noyau Linux est de 262 144. Toutefois, le paramètre UC n’est pas obligatoire et vous pouvez utiliser des valeurs d’UC inférieures à 2 ou supérieures à 262 144 dans vos définitions de conteneur. Pour les valeurs d’UC inférieures à 2 (y compris null) ou supérieures à 262 144, le comportement varie selon la version de l’agent de conteneur Amazon ECS :

Sur les instances de conteneur Windows, le quota de processeur est appliqué comme quota absolu. Les conteneurs Windows n'ont accès qu'à la quantité spécifiée de processeur décrite dans la définition de tâche. Une valeur de processeur nulle ou égale à zéro est transmise à Docker comme étant 0. Windows interprète ensuite cette valeur comme 1 % d'un processeur.

Pour voir d'autres exemples, veuillez consulter le billet de blog How Amazon ECS manages CPU and memory resources.

Type : objet ResourceRequirement

Obligatoire : non

Le nombre de GPUs physiques que l'agent de conteneur Amazon ECS réserve pour le conteneur. Le nombre de GPU réservés pour tous les conteneurs dans une tâche ne doit pas dépasser le nombre de GPU disponibles sur l'instance de conteneur sur laquelle la tâche est lancée. Pour de plus amples informations, consultez Définitions de tâches Amazon ECS pour les charges de travail GPU.

Type : objet ResourceRequirement

Obligatoire : non

Pour le type InferenceAccelerator, value correspond à deviceName d'un InferenceAccelerator spécifié dans une définition de tâche. Pour de plus amples informations, consultez Nom de l'accélérateur Elastic Inference.

Type : booléen

Obligatoire : non

Supposons que le paramètre essential d'un conteneur soit marqué comme true, et que ce conteneur échoue ou s'arrête pour une raison quelconque. Ensuite, tous les autres conteneurs qui font partie de la tâche sont arrêtés. Si le paramètre essential d'un conteneur a la valeur false, son échec n'a pas d'incidence sur le reste des conteneurs dans la tâche. Si ce paramètre n'est pas spécifié, le conteneur est supposé essentiel.

Toutes les tâches doivent comporter au moins un conteneur essentiel. Supposons que vous disposiez d'une application composée de plusieurs conteneurs. Ensuite, les conteneurs de groupes qui sont utilisés dans un même but pour former des composants, et séparer les différents composants en plusieurs définitions de tâches. Pour de plus amples informations, consultez Architect your application for Amazon ECS.

"essential": true|false

Type : tableau de chaînes

Obligatoire : non

Point d'entrée qui est transmis au conteneur.

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

Type : tableau de chaînes

Obligatoire : non

La commande transmise au conteneur. Ce paramètre correspond à Cmd dans la commande create-container et au paramètre COMMAND de docker run. S'il existe plusieurs arguments, assurez-vous que chaque argument est une chaîne séparée dans le tableau.

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

Type : chaîne

Obligatoire : non

Répertoire de travail dans lequel exécuter les commandes à l'intérieur du conteneur. Ce paramètre correspond à WorkingDir dans la section Create a container (Créer un conteneur) de l'API Docker à distance et l'option --workdir correspond à docker run.

"workingDirectory": "string"

Type : tableau d'objets

Obligatoire : non

Liste des fichiers contenant les variables d'environnement à transmettre à un conteneur. Ce paramètre correspond à l’option --env-file de la commande docker run.

Lorsque le protocole FIPS est activé, les noms de compartiments comportant des points (.) (par exemple, amzn-s3-demo-bucket1.name.example) ne sont pas pris en charge. La présence de points (.) dans le nom du compartiment empêche le démarrage de la tâche, car l’agent ne peut pas extraire le fichier de variables d’environnement depuis Amazon S3.

Ceci n'est pas disponible pour les conteneurs Windows.

Vous pouvez spécifier jusqu'à dix fichiers d'environnement. Le fichier doit avoir une extension de fichier .env. Chaque ligne d'un fichier d'environnement contient une variable d'environnement au format VARIABLE=VALUE. Les lignes commençant par # sont traitées comme des commentaires et sont ignorées.

Si des variables d'environnement individuelles sont spécifiées dans la définition du conteneur, elles ont priorité sur les variables contenues dans un fichier d'environnement. Si plusieurs fichiers d'environnement contenant la même variable sont spécifiés, ils sont traités de haut en bas. Nous vous recommandons d'utiliser des noms de variables uniques. Pour de plus amples informations, consultez Transmission d’une variable d’environnement individuelle à un conteneur Amazon ECS.

Type : tableau d'objets

Obligatoire : non

Variables d'environnement à transmettre à un conteneur. Ce paramètre correspond à Env dans la commande docker create-container et à l’option --env dans la commande docker run.

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

Type : tableau d'objets

Obligatoire : non

Objet représentant le secret à exposer à votre conteneur. Pour de plus amples informations, consultez Transmission de données sensibles vers un conteneur Amazon ECS.

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

Type : booléen

Obligatoire : non

Quand ce paramètre a la valeur true, la mise en réseau est désactivée dans le conteneur.

L’argument par défaut est false.

"disableNetworking": true|false

Type : tableau de chaînes

Obligatoire : non

Le paramètre link permet aux conteneurs de communiquer entre eux sans avoir besoin de définir des mappages de ports. Ce paramètre n'est pris en charge que si le mode réseau d'une définition de tâche est défini sur bridge. La construction name:internalName est analogue à name:alias dans les liaisons Docker. Il peut comporter jusqu’à 255 lettres (majuscules et minuscules), des chiffres, des tirets ou des traits de soulignement.

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

Type : chaîne

Obligatoire : non

Nom d'hôte à utiliser pour votre conteneur. Ce paramètre correspond à Hostname dans docker create-container et à l’option --hostname de docker run.

"hostname": "string"

Type : tableau de chaînes

Obligatoire : non

Liste de serveurs DNS qui sont présentés au conteneur.

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

Type : tableau de chaînes

Obligatoire : non

Modèle : ^[a-zA-Z0-9-.]{0,253}[a-zA-Z0-9]$

Liste des domaines de recherche DNS qui sont présentés au conteneur. Ce paramètre correspond à DnsSearch dans la commande docker create-container et à l’option --dns-search dans la commande docker run.

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

Type : tableau d'objets

Obligatoire : non

Liste de noms d'hôte et de mappages d'adresses IP à ajouter au fichier /etc/hosts dans le conteneur.

Ce paramètre correspond à ExtraHosts dans la commande docker create-container et à l’option --add-host dans la commande docker run.

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

Type : booléen

Obligatoire : non

Quand ce paramètre a la valeur true, le conteneur ne dispose que d'un accès en lecture seule au système de fichiers racine. Ce paramètre correspond à ReadonlyRootfs dans la commande docker create-container et à l’option --read-only dans la commande docker run.

L’argument par défaut est false.

"readonlyRootFilesystem": true|false

Type : tableau d'objets

Obligatoire : non

Les points de montage pour les volumes de données dans votre conteneur. Ce paramètre correspond à Volumes dans l’API Docker create-container et à l’option --volume de docker run.

Les conteneurs Windows peuvent monter des répertoires entiers sur le même lecteur que $env:ProgramData. Les conteneurs Windows ne peuvent pas monter de répertoires sur un autre lecteur, et les points de montage ne peuvent pas être utilisés sur plusieurs lecteurs. Vous devez spécifier des points de montage pour associer un volume Amazon EBS directement à une tâche Amazon ECS.

Type : tableau d'objets

Obligatoire : non

Volumes de données à monter à partir d'un autre conteneur. Ce paramètre correspond à VolumesFrom dans la commande docker create-container et à l’option --volumes-from dans la commande docker run.

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

Type : objet LogConfiguration

Obligatoire : non

Spécification de configuration du journal pour le conteneur.

Pour obtenir des exemples de définitions de tâche qui utilisent une configuration de journaux, consultez Exemple de définitions de tâches Amazon ECS.

Ce paramètre correspond à LogConfig dans la commande docker create-container et à l’option --log-driver dans la commande docker run. Par défaut, les conteneurs utilisent le même pilote de journalisation que celui utilisé par le démon Docker. Cependant, le conteneur peut utiliser un pilote de journalisation différent que celui du démon Docker en spécifiant un pilote de journal avec ce paramètre dans la définition de conteneur. Pour utiliser un pilote de journalisation différent pour un conteneur, le système de journal doit être configuré correctement sur l'instance de conteneur (ou sur un serveur de journal différent pour les options de journalisation à distance).

Tenez compte des éléments suivants lorsque vous spécifiez une configuration de journal pour vos conteneurs :

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

Type : objet FirelensConfiguration

Obligatoire : non

Configuration FireLens pour le conteneur. Cette option est utilisée pour spécifier et configurer un routeur de journal pour les journaux de conteneur. Pour de plus amples informations, consultez Envoi de journaux Amazon ECS à un service AWS ou à AWS Partner.

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

Type : tableau de chaînes

Obligatoire : non

Une liste d'ARN dans SSM ou Amazon S3 associée à un fichier de spécifications d'informations d'identification (CredSpec) qui configure le conteneur pour l'authentification Active Directory. Nous vous recommandons d'utiliser ce paramètre plutôt que les dockerSecurityOptions. Le nombre maximal d'ARN est de 1.

Il existe deux formats pour chaque ARN.

Dans les deux formats, remplacez MyARN par l'ARN dans SSM ou Amazon S3.

Le credspec doit fournir un ARN dans Secrets Manager pour un secret contenant le nom d'utilisateur, le mot de passe et le domaine auquel se connecter. Pour une meilleure sécurité, l'instance n'est pas jointe au domaine pour l'authentification sans domaine. Les autres applications de l'instance ne peuvent pas utiliser les informations d'identification sans domaine. Vous pouvez utiliser ce paramètre pour exécuter des tâches sur la même instance, même si les tâches doivent être jointes à différents domaines. Pour plus d'informations, veuillez consulter Utilisation de gMSA pour les conteneurs Windows et Utilisation de gMSAs pour les conteneurs Linux.

Type : booléen

Obligatoire : non

Quand ce paramètre a la valeur true, le conteneur dispose de droits élevés sur l'instance de conteneur hôte (similaire à l'utilisateur root). Nous vous déconseillons d'exécuter des conteneurs avec privileged. Dans la plupart des cas, vous pouvez spécifier les privilèges exacts dont vous avez besoin en utilisant les paramètres spécifiques au lieu d'utiliser privileged.

Ce paramètre correspond à Privileged dans la commande docker create-container et à l’option --privileged dans la commande docker run.

L’argument par défaut est false.

"privileged": true|false

Type : chaîne

Obligatoire : non

Utilisateur à utiliser à l'intérieur du conteneur. Ce paramètre correspond à User dans la commande docker create-container et à l’option --user dans la commande docker run.

Vous pouvez spécifier l'user à l'aide des formats suivants. Si vous spécifiez un UID ou GID, vous devez le spécifier en tant que nombre entier positif.

"user": "string"

Type : tableau de chaînes

Valeurs valides : « no-new-privileges » | « apparmor:PROFILE » | « label :value » | « credentialspec:CredentialSpecFilePath »

Obligatoire : non

Liste de chaînes pour fournir une configuration personnalisée pour plusieurs systèmes de sécurité.

Pour les tâches Linux, ce paramètre peut être utilisé pour référencer des étiquettes personnalisées pour SELinux et des systèmes de sécurité à plusieurs niveaux AppArmor .

Ce paramètre peut être utilisé pour référencer un fichier de spécification d’informations d’identification qui configure un conteneur pour l’authentification Active Directory. Pour plus d’informations, consultez Utilisation des gMSA pour les conteneurs Windows EC2 pour Amazon ECS et Utilisation de gMSA pour les conteneurs Linux EC2 sur Amazon ECS.

Ce paramètre correspond à SecurityOpt dans la commande docker create-container et à l’option --security-opt dans la commande docker run.

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

Type : tableau d'objets

Obligatoire : non

Une liste de valeurs ulimit à définir pour un conteneur. Cette valeur remplace le paramètre de quota de ressources par défaut pour le système d'exploitation. Ce paramètre correspond à Ulimits dans la commande docker create-container et à l’option --ulimit dans la commande docker run.

Ce paramètre nécessite la version 1.18 de l'API Docker à distance ou une version supérieure sur votre instance de conteneur.

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

Type : mappage chaîne/chaîne

Obligatoire : non

Correspondance clé/valeur des étiquettes à ajouter au conteneur. Ce paramètre correspond à Labels dans la commande docker create-container et à l’option --label dans la commande docker run.

Ce paramètre nécessite la version 1.18 de l'API Docker à distance ou une version supérieure sur votre instance de conteneur.

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

Type : objet LinuxParameters

Obligatoire : non

Options spécifiques à Linux appliquées au conteneur, telles que KernelCapabilities.

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

Type : tableau d'objets ContainerDependency

Obligatoire : non

Dépendances définies pour le démarrage et l'arrêt de conteneurs. Un conteneur peut contenir plusieurs dépendances. Lorsqu'une dépendance est définie pour le démarrage des conteneurs, elle est inversée pour leur arrêt. Pour obtenir un exemple, consultez Dépendance du conteneur.

Les instances nécessitent au moins la version 1.26.0 de l’agent de conteneur pour activer les dépendances de conteneur. Cependant, nous vous recommandons d'utiliser la dernière version de l'agent de conteneur. Pour plus d'informations sur la vérification de la version de votre agent et la mise à jour à la dernière version, consultez Mise à jour de l'agent de conteneur Amazon ECS. Si vous utilisez l'AMI Linux Amazon optimisée pour Amazon ECS, votre instance doit au moins disposer de la version 1.26.0-1 du package ecs-init. Si vos instances de conteneur sont lancées à partir de la version 20190301 ou ultérieure, elles contiennent les versions requises de l'agent de conteneur et ecs-init. Pour de plus amples informations, consultez AMI Amazon Linux optimisée pour Amazon ECS.

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

Type : entier

Obligatoire : non

Exemples de valeur : 120

Durée d'attente (en secondes) avant l'abandon de la résolution de dépendances pour un conteneur.

Par exemple, vous spécifiez deux conteneurs dans une définition de tâche, où le containerA dispose d'une dépendance au containerB avec un état COMPLETE, SUCCESS ou HEALTHY. Si une valeur startTimeout est spécifiée pour containerB et qu'il n'a pas atteint l'état souhaité dans ce délai, alors le containerA ne démarre pas.

La valeur maximale est de 120 secondes.

Type : entier

Obligatoire : non

Exemples de valeur : 120

Durée (en secondes) à attendre avant que le conteneur soit expressément tué s'il ne s'achève pas normalement tout seul.

Si le paramètre stopTimeout n’est pas spécifié, la valeur définie pour la variable de configuration ECS_CONTAINER_STOP_TIMEOUT de l’agent de conteneur Amazon ECS est utilisée. Si ni le paramètre stopTimeout ni la variable de configuration de l'agent ECS_CONTAINER_STOP_TIMEOUT ne sont définis, les valeurs par défaut de 30 secondes pour les conteneurs Linux et de 30 secondes pour les conteneurs Windows sont utilisées. Les instances de conteneur doivent au moins disposer de la version 1.26.0 de l'agent de conteneur pour permettre une valeur de temporisation d'arrêt d'un conteneur. Cependant, nous vous recommandons d'utiliser la dernière version de l'agent de conteneur. Pour plus d'informations sur la vérification de la version de votre agent et la mise à jour à la dernière version, consultez Mise à jour de l'agent de conteneur Amazon ECS. Si vous utilisez l'AMI Amazon Linux optimisée pour Amazon ECS, votre instance doit au moins disposer de la version 1.26.0-1 du package ecs-init. Si vos instances de conteneur sont lancées à partir de la version 20190301 ou ultérieure, elles contiennent les versions requises de l'agent de conteneur et ecs-init. Pour de plus amples informations, consultez AMI Amazon Linux optimisée pour Amazon ECS.

Type : objet SystemControl

Obligatoire : non

Liste des paramètres du noyau de l’espace de noms à définir dans le conteneur. Ce paramètre correspond à Sysctls dans la commande docker create-container et à l’option --sysctl dans la commande docker run. Par exemple, vous pouvez configurer le paramètre net.ipv4.tcp_keepalive_time pour maintenir des connexions de plus longue durée.

Il n'est pas recommandé de spécifier des paramètres systemControls liés au réseau pour plusieurs conteneurs dans une seule tâche qui utilise également le mode réseau awsvpc ou host. En procédant ainsi, vous vous exposez aux inconvénients suivants :

Si vous définissez un espace de noms des ressources IPC à utiliser pour les conteneurs de la tâche, les conditions suivantes s'appliquent aux contrôles de système. Pour de plus amples informations, consultez Mode IPC.

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

Type : booléen

Obligatoire : non

Lorsque ce paramètre est true, vous pouvez déployer des applications conteneurisées qui nécessitent l'allocation d'une stdin ou d'un tty. Ce paramètre correspond à OpenStdin dans la commande docker create-container et à l’option --interactive dans la commande docker run.

L’argument par défaut est false.

Type : booléen

Obligatoire : non

Lorsque ce paramètre a la valeur true, un TTY est alloué. Ce paramètre correspond à Tty dans la commande docker create-container et à l’option --tty dans la commande docker run.

L’argument par défaut est false.

Type : String

Obligatoire : oui

Nom de l'appareil accélérateur d'inférence élastique pour l'instance. deviceName doit également être référencé dans une définition du conteneur. Consultez Elastic Inference accelerator.

Type : String

Obligatoire : oui

L'accélérateur Elastic Inference à utiliser.

Type : chaîne

Obligatoire : non

Expression de langage de requête de cluster à appliquer à la contrainte. Pour de plus amples informations, consultez Création d’expressions pour définir des instances de conteneur pour les tâches Amazon ECS.

Type : String

Obligatoire : oui

Type de contrainte. Utilisez memberOf pour limiter la sélection à un groupe de candidats valides.

Type : objet ProxyConfiguration

Obligatoire : non

Détails de configuration pour le proxy App Mesh.

Pour les tâches qui utilisent EC2, les instances de conteneur nécessitent au moins la version 1.26.0 de l’agent de conteneur et au moins la version 1.26.0-1 du package ecs-init pour activer une configuration proxy. Si vos instances de conteneur sont lancées à partir de la version d'AMI 20190301 ou ultérieure optimisée pour Amazon ECS, elles contiennent les versions requises de l'agent de conteneur et ecs-init. Pour de plus amples informations, consultez AMI Amazon Linux optimisée pour Amazon ECS.

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

Type : chaîne

Obligatoire : non

Nom du volume. Jusqu’à 255 lettres (majuscules et minuscules), chiffres, traits d’union (-) et traits de soulignement (_) sont autorisés. Ce nom est référencé dans le paramètre sourceVolume de l’objet mountPoints de définition du conteneur.

Obligatoire : non

Le paramètre host est utilisé pour lier le cycle de vie du montage lié à l'instance Amazon EC2 hôte, plutôt qu'à la tâche et à l'endroit où elle est stockée. Si le paramètre host est vide, le démon Docker attribue un chemin hôte au volume de données, mais la persistance des données après l'arrêt des conteneurs qui lui sont associés n'est pas garantie.

Les conteneurs Windows peuvent monter des répertoires entiers sur le même lecteur que $env:ProgramData.

Type : booléen

Obligatoire : non

Spécifie si un volume est configurable au lancement. Lorsqu’il est défini sur true, vous pouvez configurer le volume lors de l’exécution d’une tâche autonome ou lors de la création ou de la mise à jour d’un service. Lorsque cette option est définie sur true, vous ne pourrez pas fournir d’autre configuration de volume dans la définition de tâche. Ce paramètre doit être défini sur true pour configurer un volume Amazon EBS à rattacher à une tâche. En définissant configuredAtLaunch sur true et en reportant la configuration du volume à la phase de lancement, vous pouvez créer des définitions de tâches qui ne sont pas limitées à un type de volume ou à des paramètres de volume spécifiques. Cela rend votre définition de tâche réutilisable dans différents environnements d’exécution. Pour plus d'informations, consultez Volumes Amazon EBS.

Type : objet DockerVolumeConfiguration

Obligatoire : non

Ce paramètre est spécifié lorsque vous utilisez des volumes Docker. Les volumes Docker sont pris en charge uniquement lors de l’exécution de tâches sur des instances EC2. Les conteneurs Windows prennent uniquement en charge l'utilisation du pilote local. Pour utiliser des montages liés, spécifiez plutôt un paramètre host.

Type : objet EFSVolumeConfiguration

Obligatoire : non

Ce paramètre est spécifié lorsque vous utilisez des volumes Amazon EFS.

Type : objet FSxWindowsFileServerVolumeConfiguration

Obligatoire : oui

Ce paramètre est spécifié lorsque vous utilisez un système de fichiers Amazon FSx for Windows File Server pour le stockage des tâches.

Type : chaîne

Obligatoire : non

Partie d'une paire clé-valeur qui constitue une étiquette. Une clé est une étiquette générale qui fait office de catégorie pour les valeurs d'étiquette plus spécifiques.

Type : chaîne

Obligatoire : non

Partie facultative d'une paire clé-valeur qui constitue une étiquette. Une valeur agit comme un descripteur au sein d'une catégorie d'étiquette (clé).

Type : chaîne

Obligatoire : non

Espace de noms de ressource IPC à utiliser pour les conteneurs de la tâche. Les valeurs valides sont host, task ou none. Si host est spécifié, tous les conteneurs des tâches ayant spécifié le mode IPC host sur la même instance de conteneur partagent les mêmes ressources IPC avec l'instance Amazon EC2 hôte. Si task est spécifié, tous les conteneurs de la tâche spécifiée partagent les mêmes ressources IPC. Si none est spécifié, les ressources IPC des conteneurs d'une tâche sont privés et ne partagent rien avec les autres conteneurs d'une tâche ou d'une instance de conteneur. Si aucune valeur n'est spécifiée, le partage de l'espace de noms de ressource IPC dépend du paramètre du démon Docker sur l'instance de conteneur.

Si le mode IPC host est utilisé, il existe un risque accru d'exposition à un espace de noms IPC indésirable.

Si vous définissez les paramètres du noyau placés dans un espace de noms à l'aide de systemControls pour les conteneurs de la tâche, les éléments suivants s'appliquent à votre espace de noms de ressource IPC.

Type : String

Valeurs valides : host | task

Obligatoire : non

Espace de noms de processus à utiliser pour les conteneurs de la tâche. Les valeurs valides sont host ou task. Par exemple, la surveillance des sidecars peut avoir besoin de pidMode pour accéder à des informations sur d'autres conteneurs exécutés dans le cadre de la même tâche.

Si host est spécifié, tous les conteneurs des tâches ayant spécifié le mode PID host sur la même instance de conteneur partagent le même espace de noms de processus avec l'instance Amazon EC2 hôte.

Si task est spécifié, tous les conteneurs de la tâche spécifiée partagent le même espace de noms de processus.

Si aucune valeur n'est spécifiée, la valeur par défaut est un espace de noms privé pour chaque conteneur.

Si le mode PID host est utilisé, il existe un risque accru d'exposition à un espace de noms de processus indésirable.

Type : booléen

Valeurs valides : true | false

Obligatoire : non

Si ce paramètre est défini sur true, dans les données utiles d’une tâche, Amazon ECS accepte les requêtes d’injection de pannes provenant des conteneurs de la tâche. Par défaut, ce paramètre est défini sur false.