Référence : Paramètres de définition du job pour ContainerProperties

Lorsque vous enregistrez une définition de tâche, vous indiquez un nom. Le nom peut comporter jusqu'à 128 caractères. Il peut contenir des lettres majuscules et minuscules, des chiffres, des traits d'union (-) et des traits de soulignement (_). La première définition de tâche enregistrée sous ce nom reçoit une révision de 1. Toutes les définitions de tâches enregistrées avec ce nom par la suite se voient attribuer un numéro de révision incrémentiel.

Type : String

Obligatoire : oui

Lorsque vous enregistrez une définition de tâche, vous indiquez le type de tâche. Si la tâche s'exécute sur les ressources Fargate, elle n'est pas prise en chargemultinode. Pour plus d'informations sur les tâches parallèles à plusieurs nœuds, consultez Création d'une définition de tâche parallèle à nœuds multiples.

Type : String

Valeurs valides : container | multinode

Obligatoire : oui

Lorsque vous soumettez une tâche, vous pouvez spécifier des paramètres qui remplacent les espaces réservés ou remplacent les paramètres de définition de tâche par défaut. Les paramètres de demandes de soumission de tâche prévalent sur les valeurs par défaut dans une définition de tâche. Cela signifie que vous pouvez utiliser la même définition de tâche pour plusieurs tâches utilisant le même format. Vous pouvez également modifier les valeurs de la commande par programmation au moment de l'envoi.

Type : mappage chaîne/chaîne

Obligatoire : non

Lorsque vous enregistrez une définition de tâche, vous pouvez utiliser les espaces réservés de substitution de paramètres dans le champ command des propriétés de conteneur de la tâche. La syntaxe est la suivante.

"command": [
    "ffmpeg",
    "-i",
    "Ref::inputfile",
    "-c",
    "Ref::codec",
    "-o",
    "Ref::outputfile"
]

Dans l'exemple ci-dessus, aucun espace réservé de substitution de paramètre Ref::inputfile, Ref::codec et Ref::outputfile n'est présent dans la commande. Vous pouvez utiliser l'parametersobjet dans la définition de tâche pour définir des valeurs par défaut pour ces espaces réservés. Par exemple, pour définir une valeur par défaut pour l'espace réservé Ref::codec, vous précisez les éléments suivants dans la définition de tâche :

"parameters" : {"codec" : "mp4"}

Lorsque cette définition de tâche est soumise pour être exécutée, l'Ref::codecargument de la commande pour le conteneur est remplacé par la valeur par défaut,mp4.

La commande transmise au conteneur. Ce paramètre correspond Cmd à la section Créer un conteneur de Docker Remote API et le COMMAND paramètre à docker run. Pour plus d'informations sur le CMD paramètre Docker, consultez https://docs.docker.com/engine/reference/builder/ #cmd.

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

Type : tableau de chaînes

Obligatoire : non

Variables d'environnement à transmettre à un conteneur. Ce paramètre correspond Env à la section Créer un conteneur de Docker Remote API et à l'--envoption de docker run.

Type : tableau de paires clé-valeur

Obligatoire : non

"environment" : [
    { "name" : "envName1", "value" : "envValue1" },
    { "name" : "envName2", "value" : "envValue2" }
]

Lorsque vous enregistrez une définition de tâche, vous pouvez spécifier un IAM rôle. Le rôle fournit à l'agent de ECS conteneur Amazon l'autorisation d'appeler en votre nom les API actions spécifiées dans ses politiques associées. Les tâches exécutées sur les ressources Fargate doivent fournir un rôle d'exécution. Pour de plus amples informations, veuillez consulter Rôle d'exécution AWS Batch IAM.

Type : chaîne

Obligatoire : non

Configuration de la plate-forme pour les tâches exécutées sur les ressources Fargate. Les tâches exécutées sur EC2 des ressources ne doivent pas spécifier ce paramètre.

Type : objet FargatePlatformConfiguration

Obligatoire : non

L'image utilisée pour démarrer une tâche. Cette chaîne est transmise directement au démon Docker. Les images dans le registre Docker Hub sont disponibles par défaut. Vous pouvez également spécifier d'autres référentiels avec repository-url/image:tag. 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 à la section Créer un conteneur de Docker Remote API et au IMAGE paramètre de docker run.

Type : String

Obligatoire : oui

Type d'instance à utiliser pour une tâche parallèle à plusieurs nœuds. Tous les groupes de nœuds dans une tâche parallèle à plusieurs nœuds doivent utiliser le même type d'instance. Ce paramètre n'est pas valide pour les tâches de conteneur à nœud unique ou pour les tâches exécutées sur des ressources Fargate.

Type : chaîne

Obligatoire : non

Lorsque vous enregistrez une définition de tâche, vous pouvez spécifier un IAM rôle. Le rôle fournit au conteneur de tâches l'autorisation d'appeler en votre nom les API actions spécifiées dans ses politiques associées. Pour plus d'informations, consultez la section IAMRôles des tâches dans le manuel Amazon Elastic Container Service Developer Guide.

Type : chaîne

Obligatoire : non

Modifications spécifiques à Linux appliquées au conteneur, telles que les détails des mappages des appareils.

"linuxParameters": {
    "devices": [
        {
            "hostPath": "string",
            "containerPath": "string",
            "permissions": [
                "READ", "WRITE", "MKNOD"
            ]
        }
    ],
    "initProcessEnabled": true|false,
    "sharedMemorySize": 0,
    "tmpfs": [
        {
            "containerPath": "string",
            "size": integer,
            "mountOptions": [
                "string"
            ]
        }
    ],
    "maxSwap": integer,
    "swappiness": integer
}

Type : objet LinuxParameters

Obligatoire : non

Spécification de configuration du journal pour la tâche.

Ce paramètre correspond LogConfig à la section Créer un conteneur de Docker Remote API et à l'--log-driveroption Docker Run. Par défaut, les conteneurs utilisent le même pilote de journalisation que celui utilisé par le démon Docker. Toutefois, le conteneur peut utiliser un pilote de journalisation différent de celui du daemon Docker en spécifiant un pilote de journal avec ce paramètre dans la définition du conteneur. Pour utiliser un pilote de journalisation différent pour un conteneur, le système de journalisation doit être configuré sur l'instance du conteneur ou sur un autre serveur de journaux afin de fournir des options de journalisation à distance. Pour plus d'informations sur les options relatives aux différents pilotes du journal pris en charge, consultez la section Configure logging drivers (Configurer les pilotes de journalisation) dans la documentation Docker.

Ce paramètre nécessite la version 1.18 de Docker Remote API ou une version ultérieure sur votre instance de conteneur. Pour vérifier la API version de Docker Remote sur votre instance de conteneur, connectez-vous à votre instance de conteneur et exécutez la commande suivante : sudo docker version | grep "Server API version"

"logConfiguration": {
    "devices": [
        {
            "logDriver": "string",
            "options": {
                "optionName1" : "optionValue1",
                "optionName2" : "optionValue2"
            }
            "secretOptions": [
              {
                  "name" : "secretOptionName1",
                  "valueFrom" : "secretOptionArn1"
              },
              {
                  "name" : "secretOptionName2",
                  "valueFrom" : "secretOptionArn2"
              }
            ]
        }
    ]
}

Type : objet LogConfiguration

Obligatoire : non

Ce paramètre est obsolète, resourceRequirements utilisez-le à la place.

Le nombre de MiB de mémoire réservé à la tâche.

À titre d'exemple d'utilisationresourceRequirements, si votre définition de tâche contient une syntaxe similaire à la suivante.

"containerProperties": {
  "memory": 512
}

La syntaxe équivalente utilisée resourceRequirements est la suivante.

"containerProperties": {
  "resourceRequirements": [
    {
      "type": "MEMORY",
      "value": "512"
    }
  ]
}

Type : entier

Obligatoire : oui

Points de montage des volumes de données dans votre conteneur. Ce paramètre correspond Volumes à la section Créer un conteneur de Docker Remote API et à l'--volumeoption de docker run.

"mountPoints": [
                {
                  "sourceVolume": "string",
                  "containerPath": "string",
                  "readOnly": true|false
                }
              ]

Type : tableau d'objets

Obligatoire : non

Configuration réseau pour les tâches exécutées sur les ressources Fargate. Les tâches exécutées sur EC2 des ressources ne doivent pas spécifier ce paramètre.

"networkConfiguration": { 
   "assignPublicIp": "string"
}

Type : tableau d'objets

Obligatoire : non

Lorsque ce paramètre est défini sur true (vrai), des autorisations élevées inhérentes à l'instance de conteneur hôte sont accordées au conteneur (semblable à l'utilisateur root). Ce paramètre correspond Privileged à la section Créer un conteneur de Docker Remote API et à l'--privilegedoption de docker run. Ce paramètre ne s'applique pas aux tâches exécutées sur les ressources Fargate. Ne le fournissez pas et ne le spécifiez pas comme faux.

"privileged": true|false

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 à la section Créer un conteneur de Docker Remote API et à l'--read-onlyoption de docker run.

"readonlyRootFilesystem": true|false

Type : booléen

Obligatoire : non

Type et quantité d'une ressource à attribuer à un conteneur. Les ressources prises en charge comprennent GPU, MEMORY et VCPU.

"resourceRequirements" : [
  {
    "type": "GPU",
    "value": "number"
  }
]

Type : tableau d'objets

Obligatoire : non

Les secrets du travail exposés sous forme de variables d'environnement. Pour de plus amples informations, veuillez consulter Spécifier les données sensibles.

"secrets": [
    {
      "name": "secretName1",
      "valueFrom": "secretArn1"
    },
    {
      "name": "secretName2",
      "valueFrom": "secretArn2"
    }
    ...
]

Type : tableau d'objets

Obligatoire : non

Une liste de valeurs ulimits à définir dans le conteneur. Ce paramètre correspond Ulimits à la section Créer un conteneur de Docker Remote API et à l'--ulimitoption de docker run.

"ulimits": [
  {
    "name": string,
    "softLimit": integer,
    "hardLimit": integer
  }
  ...
]

Type : tableau d'objets

Obligatoire : non

Le nom utilisateur à utiliser à l'intérieur du conteneur. Ce paramètre correspond User à la section Créer un conteneur de Docker Remote API et à l'--useroption de docker run.

"user": "string"

Type : chaîne

Obligatoire : non

Ce paramètre est obsolète, resourceRequirements utilisez-le à la place.

Le nombre de vCPUs livres réservés pour le conteneur.

À titre d'exemple d'utilisationresourceRequirements, si votre définition de tâche contient des lignes similaires à celles-ci :

"containerProperties": {
  "vcpus": 2
}

Les lignes équivalentes utilisées resourceRequirements sont les suivantes.

"containerProperties": {
  "resourceRequirements": [
    {
      "type": "VCPU",
      "value": "2"
    }
  ]
}

Type : entier

Obligatoire : oui

Lorsque vous enregistrez une définition de tâche, vous pouvez éventuellement préciser une liste de volumes qui sont transmis au daemon Docker sur une instance de conteneur. Les paramètres suivants sont autorisés dans les propriétés du conteneur :

"volumes": [
  {
    "name": "string",
    "host": {
      "sourcePath": "string"
    },
    "efsVolumeConfiguration": {
      "authorizationConfig": {
        "accessPointId": "string",
        "iam": "string"
      },
      "fileSystemId": "string",
      "rootDirectory": "string",
      "transitEncryption": "string",
      "transitEncryptionPort": number
    }
  }
]

Les propriétés du Kubernetes ressources d'un emploi.

Type : objet EksPodProperties

Obligatoire : non

Les fonctionnalités de la plateforme requises par la définition du poste. Si aucune valeur n'est spécifiée, elle est par défaut EC2. Pour les tâches exécutées sur des ressources FARGATE Fargate, est spécifié.

Type : String

Valeurs valides : EC2 | FARGATE

Obligatoire : non

Spécifie s'il faut propager les balises de la tâche ou de la définition de la tâche vers la ECS tâche Amazon correspondante. Si aucune valeur n'est spécifiée, les balises ne sont pas propagées. Les balises ne peuvent être propagées aux tâches que lorsque celles-ci sont créées. Pour les balises portant le même nom, les balises de tâche ont la priorité sur les balises de définition de tâche. Si le nombre total de balises combinées entre la tâche et la définition de la tâche est supérieur à 50, la tâche est déplacée vers l'FAILEDétat.

Type : booléen

Obligatoire : non

Lorsque vous enregistrez une définition de tâche parallèle à nœuds multiples, vous devez spécifier une liste de propriétés de nœuds. Ces propriétés de nœud définissent le nombre de nœuds à utiliser dans votre tâche, l'index des nœuds principaux et les différentes plages de nœuds à utiliser. Si la tâche s'exécute sur les ressources Fargate, vous ne pouvez pas le spécifier. nodeProperties Utilisez à la place containerProperties. Les propriétés de nœud suivantes sont autorisées dans une définition de tâche. Pour de plus amples informations, veuillez consulter Tâches parallélisées sur plusieurs nœuds.

Type : objet NodeProperties

Obligatoire : non

Lorsque vous enregistrez une définition de tâche, vous pouvez, si vous le souhaitez, définir une stratégie de nouvelle tentative à adopter pour les tâches en échec qui sont soumises avec cette définition de tâche. Toute stratégie de nouvelle tentative spécifiée au cours d'une SubmitJobopération remplace la stratégie de nouvelle tentative définie ici. Par défaut, chaque tâche est lancée une seule fois. Si vous spécifiez plusieurs tentatives, la tâche est réessayée en cas d'échec. Parmi les exemples de tentative d'échec, citons le renvoi d'un code de sortie différent de zéro par la tâche ou l'arrêt de l'instance de conteneur. Pour de plus amples informations, veuillez consulter Nouvelles tentatives de travail automatisées.

Type : objet RetryStrategy

Obligatoire : non

Priorité de planification pour les tâches soumises avec cette définition de tâche. Cela n'affecte que les tâches dans les files d'attente de tâches avec une politique de partage équitable. Les tâches avec une priorité de planification plus élevée sont planifiées avant celles dont la priorité de planification est inférieure.

La valeur minimale prise en charge est 0 et la valeur maximale prise en charge est 9999.

Type : entier

Obligatoire : non

Balises de paire clé-valeur à associer à la définition de la tâche. Pour de plus amples informations, veuillez consulter Marquez vos AWS Batch ressources.

Type : mappage chaîne/chaîne

Obligatoire : non

Vous pouvez configurer un délai d'expiration pour vos tâches de telle sorte que si une tâche dure plus longtemps, AWS Batch elle soit interrompue. Pour de plus amples informations, veuillez consulter Expiration des délais d'exécution des tâches. Si une tâche est interrompue en raison d'un délai imparti, elle n'est pas réessayée. Toute configuration de temporisation spécifiée au cours d'une SubmitJobopération remplace la configuration de temporisation définie ici. Pour de plus amples informations, veuillez consulter Expiration des délais d'exécution des tâches.

Type : objet JobTimeout

Obligatoire : non