Jobdefinitionsparameter für ContainerProperties

Wenn Sie eine Auftragsdefinition registrieren, geben Sie einen Namen ein. Der Name kann bis zu 128 Zeichen lang sein. Er kann Groß- und Kleinbuchstaben, Zahlen, Bindestriche (-) und Unterstriche (_) enthalten. Die erste Jobdefinition, die mit diesem Namen registriert ist, erhält die Revision 1. Alle nachfolgenden Auftragsdefinitionen, die mit diesem Namen registriert werden, erhalten eine inkrementelle Versionsnummer.

Typ: Zeichenfolge

Erforderlich: Ja

Wenn Sie eine Auftragsdefinition registrieren, geben Sie den Auftragstyp an. Wenn der Job auf Fargate- oder Amazon ECS Managed Instances-Ressourcen ausgeführt wird, dann multinode wird nicht unterstützt. Weitere Informationen zu parallelen Aufträgen mit mehreren Knoten finden Sie unter Eine parallel Jobdefinition mit mehreren Knoten erstellen.

Typ: Zeichenfolge

Zulässige Werte: container | multinode

Erforderlich: Ja

Wenn Sie einen Job einreichen, können Sie Parameter angeben, die die Platzhalter ersetzen oder die Standardparameter der Auftragsdefinition überschreiben. Die Parameter in Anforderungen zum Senden von Aufträgen haben Vorrang vor den Standardeinstellungen in einer Auftragsdefinition. Das bedeutet, dass Sie dieselbe Auftragsdefinition für mehrere Jobs verwenden können, die dasselbe Format verwenden. Sie können die Werte im Befehl bei der Übermittlung auch programmgesteuert ändern.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Erforderlich: Nein

Wenn Sie eine Auftragsdefinition registrieren, können Sie Parameterersetzungsplatzhalter in das Feld command der Container-Eigenschaften eines Auftrags verwenden. Die Syntax ist wie folgt.

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

AWS Batch untersucht jedes Element in der command Reihe. Wenn ein Element beginnt mit Ref::, AWS Batch entfernt das Präfix und verwendet den verbleibenden Text als Parametername. Daher muss jeder Platzhalter für die Parameterersetzung ein separater Platzhalter sein command Array-Element. AWS Batch sucht oder ersetzt keine Platzhalter, die in eine andere Zeichenfolge eingebettet sind. Zum Beispiel s3://Ref::s3Bucket/Ref::objectKey wird unverändert an den Container übergeben.

Um diesen S3-URI zu erstellen mit bash -c, übergeben Sie jeden Platzhalter als separates Befehlsarray-Element und verweisen Sie in der Befehlszeichenfolge auf die ersetzten Werte als Positionsparameter. Beispiel:

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

AWS Batch ersetzt Ref::s3Bucket und Ref::objectKey bevor der Container startet. Das _ hochwertige Lieferungen $0, also Bash erhält den ersetzten Bucket und den Objektschlüssel als $1 und $2.

In der ffmpeg Zum Beispiel gibt es Ref::inputfile, Ref::codec, und Ref::outputfile Platzhalter für die Parameterersetzung im Befehl. Sie können das verwenden parameters Objekt in der Jobdefinition, um Standardwerte für diese Platzhalter festzulegen. Um beispielsweise einen Standard für die Ref::codec-Platzhalter einzustellen, legen Sie Folgendes in der Auftragsdefinition fest:

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

Wenn diese Auftragsdefinition zur Ausführung eingereicht wird, wird Ref::codec Das Argument im Befehl für den Container wird durch den Standardwert ersetzt, mp4.

Der Befehl, der an den Container übergeben wird. Dieser Parameter ist Cmd im Abschnitt Erstellen eines Containers der Docker Remote-API und dem Parameter COMMAND von docker run zugeordnet. Für weitere Informationen über den Docker CMD Parameter, siehe https://docs.docker.com/engine/reference/builder/#cmd.

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

Typ: Zeichenfolgen-Array

Erforderlich: Nein

Die Umgebungsvariablen, die an einen Container übergeben werden. Dieser Parameter ordnet zu Env im Bereich Erstellen eines Containers der Docker Remote API und der Option --env für die docker run zu.

Typ: Array von Schlüssel-Wert-Paaren

Erforderlich: Nein

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

Wenn Sie eine Jobdefinition registrieren, können Sie eine IAM-Rolle angeben. Die Rolle gewährt dem Amazon ECS-Container-Agenten die Berechtigung, die API-Aktionen, die in den zugehörigen Richtlinien angegeben sind, in Ihrem Namen aufzurufen. Jobs, die auf Fargate-Ressourcen ausgeführt werden, müssen eine Ausführungsrolle bereitstellen. Weitere Informationen finden Sie unter AWS Batch Rolle „IAM-Ausführung“.

Typ: Zeichenfolge

Erforderlich: Nein

Die Plattformkonfiguration für Jobs, die auf Fargate-Ressourcen ausgeführt werden. Aufgaben, die auf EC2-Ressourcen laufen, dürfen diesen Parameter nicht angeben.

Typ: FargatePlatformConfiguration Objekt

Erforderlich: Nein

Das Bild, mit dem ein Job gestartet wurde. Diese Zeichenfolge wird direkt an den Docker-Daemon übergeben. Bilder in der Docker Hub-Registrierung sind standardmäßig verfügbar. Sie können auch andere Repositorys mit repository-url/image:tag angeben. Bis zu 255 Buchstaben (Groß- und Kleinbuchstaben), Ziffern, Bindestriche, Unterstriche, Doppelpunkte, Punkte und Schrägstriche sind zulässig. Dieser Parameter wird Image zugeordnet im Abschnitt Create a container (Erstellen eines Containers) im Docker-Remote-API und dem IMAGE-Parameter von docker run.

Typ: Zeichenfolge

Erforderlich: Ja

Der Instance-Typ zur Verwendung für einen parallelen Auftrag mit mehreren Knoten. Alle Knotengruppen müssen in einem parallelen Auftrag mit mehreren Knoten den gleichen Instance-Typ verwenden. Dieser Parameter ist nicht gültig für Container-Jobs mit einem Knoten oder für Jobs, die auf Fargate-Ressourcen ausgeführt werden.

Typ: Zeichenfolge

Erforderlich: Nein

Wenn Sie eine Auftragsdefinition registrieren, können Sie eine IAM-Rolle angeben. Die Rolle stellt dem Auftrags-Container Berechtigungen zum Aufrufen der API-Aktionen zur Verfügung, die in den zugehörigen Richtlinien in Ihrem Namen festgelegt sind. Weitere Informationen finden Sie unter IAM-Rollen für Aufgaben im Entwicklerhandbuch zum Amazon Elastic Container Service.

Typ: Zeichenfolge

Erforderlich: Nein

Linux-specific Änderungen, die auf den Container angewendet werden, z. B. Details für Gerätezuordnungen.

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

Typ: LinuxParameters Objekt

Erforderlich: Nein

Die Protokollkonfigurationsspezifikation für den Job.

Dieser Parameter ist LogConfig im Abschnitt Einen Container erstellen der Docker-Remote-API und der Option --log-driver für die Docker-Ausführung zugeordnet. Standardmäßig verwenden Container den gleichen Protokolltreiber wie der Docker-Daemon. Der Container kann jedoch einen anderen Logging-Treiber als der Docker-Daemon verwenden, indem Sie in der Container-Definition einen Log-Treiber mit diesem Parameter angeben. Um einen anderen Logging-Treiber für einen Container zu verwenden, muss das Logsystem entweder auf der Container-Instance oder auf einem anderen Log-Server konfiguriert werden, um Remote-Logging-Optionen bereitzustellen. Weitere Informationen zu den Optionen für die verschiedenen unterstützten Protokolltreiber finden Sie unter Configure logging drivers (Protokolltreiber konfigurieren) in der Docker-Dokumentation.

Für diesen Parameter ist Version 1.18 der Docker Remote API oder höher auf Ihrer Container-Instance erforderlich. Um die Docker Remote API-Version auf Ihrer Container-Instance zu überprüfen, melden Sie sich bei Ihrer Container-Instance an und führen Sie den folgenden Befehl aus: 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"
              }
            ]
        }
    ]
}

Typ: LogConfiguration Objekt

Erforderlich: Nein

Dieser Parameter ist veraltet. Verwenden Sie resourceRequirements stattdessen.

Die Anzahl der MiB an Speicher, die für den Job reserviert sind.

Als Beispiel für die Verwendung resourceRequirements, wenn Ihre Jobdefinition eine Syntax enthält, die der folgenden ähnelt.

"containerProperties": {
  "memory": 512
}

Die äquivalente Syntax mit resourceRequirements lautet wie folgt.

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

Typ: Ganzzahl

Erforderlich: Ja

Die Mountingpunkte für Daten-Volumes in Ihrem Container. Dieser Parameter ordnet zu Volumes im Bereich Erstellen eines Containers der Docker Remote API und der Option --volume für die docker run zu.

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

Typ: Objekt-Array

Erforderlich: Nein

Die Netzwerkkonfiguration für Jobs, die auf Fargate-Ressourcen ausgeführt werden. Aufgaben, die auf EC2-Ressourcen laufen, dürfen diesen Parameter nicht angeben.

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

Typ: Objekt-Array

Erforderlich: Nein

Wenn dieser Parameter den Wert „true“ aufweist, erhält der Container erhöhte Berechtigungen auf der Host-Container-Instance (ähnlich wie der root-Benutzer). Dieser Parameter ordnet zu Privileged im Bereich Erstellen eines Containers der Docker Remote API und der Option --privileged für die docker run zu. Dieser Parameter ist nicht auf Aufträge anwendbar, die auf Fargate-Ressourcen ausgeführt werden. Geben Sie es nicht an oder geben Sie es als falsch an.

"privileged": true|false

Typ: Boolesch

Erforderlich: Nein

Wenn dieser Parameter den Wert „true“ aufweist, erhält der Container Lesezugriff auf das Root-Dateisystem. Dieser Parameter ordnet zu ReadonlyRootfs im Bereich Erstellen eines Containers der Docker Remote API und der Option --read-only für die docker run zu.

"readonlyRootFilesystem": true|false

Typ: Boolesch

Erforderlich: Nein

Die Art und Menge einer Ressource, die einem Container zugewiesen werden soll. Zu den unterstützten Ressourcen gehören GPU, MEMORY und VCPU.

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

Typ: Objekt-Array

Erforderlich: Nein

Ein Objekt, das die Computerumgebungsarchitektur für darstellt AWS Batch Jobs. Dieser Parameter gilt für Jobs, die auf ausgeführt werden AWS Ressourcen für verwaltete Instanzen von Fargate und Amazon ECS.

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

Typ: RuntimePlatform Objekt

Erforderlich: Nein

Die Geheimnisse für den Job, die als Umgebungsvariablen verfügbar gemacht werden. Weitere Informationen finden Sie unter Geben Sie sensible Daten an.

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

Typ: Objekt-Array

Erforderlich: Nein

Eine Liste der ulimits-Werte, die im Container festgelegt werden sollen. Dieser Parameter ordnet zu Ulimits im Bereich Erstellen eines Containers der Docker Remote API und der Option --ulimit für die docker run zu.

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

Typ: Objekt-Array

Erforderlich: Nein

Der Benutzername, der im Container verwendet werden soll. Dieser Parameter ordnet zu User im Bereich Erstellen eines Containers der Docker Remote API und der Option --user für die docker run zu.

"user": "string"

Typ: Zeichenfolge

Erforderlich: Nein

Dieser Parameter ist veraltet. Verwenden Sie resourceRequirements stattdessen.

Die Anzahl von vCPUs, die für den Container reserviert sind.

Als Beispiel für die Verwendung resourceRequirements, wenn Ihre Jobdefinition Zeilen wie diese enthält:

"containerProperties": {
  "vcpus": 2
}

Die entsprechenden Zeilen mit resourceRequirements ist wie folgt.

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

Typ: Ganzzahl

Erforderlich: Ja

Wenn Sie eine Auftragsdefinition registrieren, können Sie eine Liste der Volumes angeben, die an den Docker-Daemon in einer Container-Instance übergeben werden sollen. Die folgenden Parameter sind in den Container-Eigenschaften zulässig:

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

Die Eigenschaften für Kubernetes Pod-Ressourcen eines Jobs.

Typ: EksPodProperties Objekt

Erforderlich: Nein

Die Plattformfunktionen, die für die Jobdefinition erforderlich sind. Wenn kein Wert angegeben wird, wird standardmäßig der Wert EC2 verwendet. Für Jobs, die auf Fargate-Ressourcen ausgeführt werden, FARGATE ist spezifiziert. Für Jobs, die auf Amazon ECS Managed Instances ausgeführt werden, MANAGED_INSTANCES ist angegeben.

Jobs bei der MANAGED_INSTANCES Die Plattformfähigkeit muss verwendet werden ecsProperties (nicht containerProperties) und unterstützen keine parallelen Jobs mit mehreren Knoten. Weitere Informationen finden Sie unter Auftragsdefinitionen auf von Amazon ECS verwalteten Instances.

Typ: Zeichenfolge

Zulässige Werte: EC2 | FARGATE | MANAGED_INSTANCES

Erforderlich: Nein

Gibt an, ob die Tags aus dem Auftrag oder der Auftragsdefinition an die entsprechende Amazon ECS-Aufgabe weitergegeben werden sollen. Wenn kein Wert angegeben wird, werden die Tags nicht weitergegeben. Schlagworte können nur an die Aufgaben weitergegeben werden, wenn die Aufgabe erstellt wird. Bei Tags mit demselben Namen haben Auftrags-Tags Vorrang vor Auftragsdefinitions-Tags. Wenn die Gesamtzahl der kombinierten Stichwörter aus der Auftrags- und Auftragsdefinition über 50 liegt, wird der Job in den FAILED Bundesstaat.

Typ: Boolesch

Erforderlich: Nein

Wenn Sie eine parallele Jobdefinition mit mehreren Knoten registrieren, müssen Sie eine Liste von Knoteneigenschaften angeben. Diese Knoteneigenschaften definieren die Anzahl der Knoten, die in Ihrem Job verwendet werden sollen, den Hauptknotenindex und die verschiedenen zu verwendenden Knotenbereiche. Wenn der Job auf Fargate-Ressourcen ausgeführt wird, können Sie dies nicht angeben nodeProperties. Nutzen Sie stattdessen containerProperties. Die folgenden Knoteneigenschaften sind in einer Auftragsdefinition zulässig. Weitere Informationen finden Sie unter Multi-node parallele Jobs.

Typ: NodeProperties Objekt

Erforderlich: Nein

Wenn Sie eine Auftragsdefinition registrieren, können Sie optional eine Wiederholungsstrategie für fehlgeschlagene Aufträge angeben, die mit dieser Auftragsdefinition übermittelt werden. Jede Wiederholungsstrategie, die während einer angegeben wurde SubmitJob Die Operation überschreibt die hier definierte Wiederholungsstrategie. Standardmäßig erfolgt ein Ausführungsversuch pro Auftrag. Wenn Sie mehr als einen Versuch angeben, wird der Auftrag erneut versucht, wenn er fehlschlägt. Zu den Beispielen für einen fehlgeschlagenen Versuch gehören, dass der Job einen Exit-Code ungleich Null zurückgibt oder die Container-Instance beendet wird. Weitere Informationen finden Sie unter Automatisierte Auftragswiederholungen.

Typ: RetryStrategy Objekt

Erforderlich: Nein

Die Planungspriorität für Jobs, die mit dieser Auftragsdefinition eingereicht werden. Dies betrifft nur Jobs in Auftragswarteschlangen, für die eine Fair-Share-Richtlinie gilt. Aufgaben mit einer höheren Planungspriorität werden vor Aufgaben mit einer niedrigeren Planungspriorität geplant.

Der unterstützte Mindestwert ist 0 und der unterstützte Höchstwert ist 9999.

Typ: Ganzzahl

Erforderlich: Nein

Key-value paaren Sie Stichwörter, um sie der Auftragsdefinition zuzuordnen. Weitere Informationen finden Sie unter Kennzeichnen Sie Ihre AWS Batch Ressourcen.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Erforderlich: Nein

Sie können eine Timeout-Dauer für Ihre Jobs konfigurieren, sodass, wenn ein Job länger läuft, AWS Batch beendet den Job. Weitere Informationen finden Sie unter Zeitüberschreitungen bei Aufträgen. Wenn ein Job aufgrund eines Timeouts beendet wird, wird er nicht erneut versucht. Jede Timeout-Konfiguration, die während einer angegeben wird SubmitJob Die Operation überschreibt die hier definierte Timeout-Konfiguration. Weitere Informationen finden Sie unter Zeitüberschreitungen bei Aufträgen.

Typ: JobTimeout Objekt

Erforderlich: Nein