Paramètres de définition des tâches 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 poste 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 : chaîne

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 ou Amazon ECS Managed Instances, alors multinode n'est pas pris en charge. 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 la soumission.

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

AWS Batch examine chaque élément du command tableau. Si un élément commence par Ref::, AWS Batch supprime le préfixe et utilise le texte restant comme nom de paramètre. Par conséquent, chaque espace réservé pour la substitution de paramètres doit être distinct command élément de tableau. AWS Batch ne recherche ni ne remplace les espaces réservés incorporés dans une autre chaîne. Par exemple, s3://Ref::s3Bucket/Ref::objectKey est transmis au conteneur tel quel.

Pour construire cet URI S3 avec bash -c, transmettez chaque espace réservé en tant qu'élément distinct du tableau de commandes et faites référence aux valeurs substituées en tant que paramètres de position dans la chaîne de commande. Par exemple :

"command": [
    "/bin/bash",
    "-c",
    "aws s3 cp \"s3://$1/$2\" ./input-file",
    "_",
    "Ref::s3Bucket",
    "Ref::objectKey"
]

AWS Batch remplace Ref::s3Bucket et Ref::objectKey avant le démarrage du conteneur. Le _ fournitures de valeur $0, donc Bash reçoit le compartiment et la clé d'objet substitués sous la forme $1 et $2.

Dans le ffmpeg par exemple, il y a Ref::inputfile, Ref::codec, et Ref::outputfile espaces réservés pour la substitution de paramètres dans la commande. Vous pouvez utiliser le parameters objet 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 exécution, le Ref::codec l'argument 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 dans la section Create a container (Création d'un conteneur) de Docker Remote API (API distante Docker) et au paramètre COMMAND de docker run. Pour plus d'informations sur le Docker CMD paramètre, voir 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 dans la section Create a container (Créer un conteneur) de l'API Docker à distance et l'option --env correspond à 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 rôle IAM. Le rôle confère à l'agent de conteneur Amazon ECS les autorisations nécessaires pour appeler en votre nom les actions d'API 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 plus d’informations, consultez AWS Batch Rôle d'exécution 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 des ressources EC2 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 du 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 se mappe à Image dans la section Create a container (Création d'un conteneur) de Docker Remote API (L'API Docker à distance) et le paramètre IMAGE de docker run.

Type : chaîne

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 les ressources Fargate.

Type : chaîne

Obligatoire : non

Lorsque vous enregistrez une définition de tâche, vous pouvez spécifier un rôle IAM. Le rôle autorise le conteneur de tâches à appeler les actions d'API qui sont spécifiées dans ses stratégies associées à votre place. Pour plus d’informations, consultez Rôles IAM pour les tâches dans le Guide du développeur Amazon Elastic Container Service.

Type : chaîne

Obligatoire : non

Linux-specific les modifications appliquées au conteneur, telles que les détails des mappages de périphériques.

"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

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

Ce paramètre correspond à LogConfig dans la section Create a container (Créer un conteneur) de Docker Remote API et l'option --log-driver à 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 de celui du démon Docker en spécifiant un pilote de journalisation 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 journalisation 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 l'API Docker Remote ou une version ultérieure sur votre instance de conteneur. Pour vérifier la version de l'API Docker à distance de 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, utilisez resourceRequirements au lieu de cela.

Nombre de Mo de mémoire réservés pour la tâche.

À titre d'exemple pour savoir comment utiliser resourceRequirements, si votre définition de poste contient une syntaxe similaire à la suivante.

"containerProperties": {
  "memory": 512
}

La syntaxe équivalente utilisant resourceRequirements est le suivant.

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

Type : Integer

Obligatoire : oui

Points de montage des volumes de données dans votre conteneur. Ce paramètre correspond à Volumes dans la section Create a container (Créer un conteneur) de l'API Docker à distance et l'option --volume correspond à 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 des ressources EC2 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 dans la section Create a container (Créer un conteneur) de l'API Docker à distance et l'option --privileged correspond à docker run. Ce paramètre ne s'applique pas aux tâches exécutées sur les ressources Fargate. Ne le fournissez pas ou 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 dans la section Create a container (Créer un conteneur) de l'API Docker à distance et l'option --read-only correspond à 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

Un objet qui représente l'architecture de l'environnement de calcul pour AWS Batch emplois. Ce paramètre s'applique aux tâches qui s'exécutent sur AWS Ressources sur Fargate et Amazon ECS Managed Instances.

"runtimePlatform": {
    "cpuArchitecture": "string",
    "operatingSystemFamily": "string"
}

Type : objet RuntimePlatform

Obligatoire : non

Les secrets de la tâche qui sont exposés sous forme de variables d'environnement. Pour plus d’informations, consultez 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 dans la section Create a container (Créer un conteneur) de l'API Docker à distance et l'option --ulimit correspond à 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 dans la section Create a container (Créer un conteneur) de l'API Docker à distance et l'option --user correspond à docker run.

"user": "string"

Type : chaîne

Obligatoire : non

Ce paramètre est obsolète, utilisez resourceRequirements au lieu de cela.

Nombre de processeurs virtuels réservés pour le conteneur.

À titre d'exemple pour savoir comment utiliser resourceRequirements, si votre définition de poste contient des lignes similaires à celles-ci :

"containerProperties": {
  "vcpus": 2
}

Les lignes équivalentes utilisant resourceRequirements est le suivant.

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

Type : Integer

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 de Kubernetes les ressources d'une tâche.

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 les ressources de Fargate, FARGATE est spécifié. Pour les tâches exécutées sur des instances gérées Amazon ECS, MANAGED_INSTANCES est spécifié.

Emplois chez MANAGED_INSTANCES la capacité de la plate-forme doit utiliser ecsProperties (pas containerProperties) et ne prennent pas en charge les tâches parallèles multi-nœuds. Pour plus d’informations, consultez Définitions des tâches sur les instances gérées Amazon ECS.

Type : String

Valeurs valides : EC2 | FARGATE | MANAGED_INSTANCES

Obligatoire : non

Spécifie s'il faut propager les balises de tâche ou de la définition de tâche vers la tâche Amazon ECS 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 de la tâche et de la définition de la tâche est supérieur à 50, la tâche est déplacée vers le FAILED état.

Type : booléen

Obligatoire : non

Lorsque vous enregistrez une définition de tâche parallèle multi-nœuds, vous devez spécifier une liste de propriétés de nœud. Ces propriétés de nœud définissent le nombre de nœuds à utiliser dans votre tâche, l'index de nœud principal et les différentes plages de nœuds à utiliser. Si la tâche s'exécute sur les ressources Fargate, vous ne pouvez pas 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 plus d’informations, consultez Multi-node emplois parallèles.

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 lors d'une SubmitJob operation 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 fait que la tâche renvoie un code de sortie différent de zéro ou que l'instance de conteneur est terminée. Pour plus d’informations, consultez Reprises 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 ne concerne que les emplois en attente d'emploi dans le cadre d'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 : Integer

Obligatoire : non

Key-value paires de balises à associer à la définition du poste. Pour plus d’informations, consultez Marquez vos AWS Batch ressources.

Type : mappage chaîne/chaîne

Obligatoire : non

Vous pouvez configurer une durée d'expiration pour vos tâches de sorte que si une tâche s'exécute plus longtemps que cela, AWS Batch met fin au travail. Pour plus d’informations, consultez Délais d'exécution des tâches. Si une tâche est interrompue en raison d'un délai d'attente, elle n'est pas réessayée. Toute configuration de temporisation spécifiée au cours d'une SubmitJob operation remplace la configuration du délai d'attente définie ici. Pour plus d’informations, consultez Délais d'exécution des tâches.

Type : objet JobTimeout

Obligatoire : non