Parametri di definizione del lavoro per ContainerProperties

Quando si registra una definizione di processo, è necessario specificare un nome, Il nome può contenere fino a 128 caratteri. Deve contenere lettere maiuscole e minuscole, numeri, trattini (-) e caratteri di sottolineatura (_). Alla prima definizione di processo registrata con quel nome viene assegnata una revisione pari a 1. Tutte le successive definizioni del processo registrate con tale nome vengono contrassegnate con un numero di revisione incrementale.

Tipo: stringa

Campo obbligatorio: sì

Quando si registra una definizione di processo, è necessario specificare il tipo di processo. Se il processo viene eseguito su risorse Fargate, multinode non è supportato. Per ulteriori informazioni sui processi in parallelo a più nodi, consulta Creazione di una definizione di processo parallelo a più nodi.

▬Tipo: stringa

Valori validi: container | multinode

Campo obbligatorio: sì

Quando invii un lavoro, puoi specificare parametri che sostituiscono i segnaposto o sostituiscono i parametri di definizione del lavoro predefiniti. I parametri delle richieste di invio del processo hanno priorità rispetto ai valori predefiniti di una definizione del processo. Ciò significa che è possibile utilizzare la stessa definizione di processo per più lavori che utilizzano lo stesso formato. È inoltre possibile modificare a livello di codice i valori del comando al momento dell'invio.

Tipo: mappatura stringa a stringa

Campo obbligatorio: no

Quando si registra una definizione di processo, è possibile utilizzare segnaposto di sostituzione dei parametri nel campo command delle proprietà del container del processo. La sintassi è esposta di seguito.

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

Nell'esempio precedente, sono presenti segnaposto per la sostituzione del parametro Ref::inputfile, Ref::codec e Ref::outputfile nel comando. È possibile utilizzare l'parametersoggetto nella definizione del processo per impostare valori predefiniti per questi segnaposto. Ad esempio, per impostare un valore predefinito per il segnaposto Ref::codec, è necessario specificare quanto segue nella definizione del processo:

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

Quando questa definizione di processo viene inviata per l'esecuzione, l'Ref::codecargomento nel comando per il contenitore viene sostituito con il valore predefinito,. mp4

Il comando che viene inviato al container. Questo parametro è mappato a Cmd nella sezione Crea un container dell'API remota Docker e al parametro COMMAND di docker run. Per ulteriori informazioni sul parametro Docker CMD, consulta https://docs.docker.com/engine/reference/builder/#cmd.

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

Tipo: array di stringhe

Campo obbligatorio: no

Le variabili di ambiente da passare a un container. Questo parametro è mappato a Env nella sezione Create a container di Docker Remote API e l'opzione --env a docker run.

Tipo: array di coppie chiave-valore

Campo obbligatorio: no

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

Quando registri una definizione di lavoro, puoi specificare un ruolo IAM. Il ruolo fornisce all'agente container Amazon ECS le autorizzazioni per richiamare le azioni API specificate nelle politiche associate per tuo conto. I lavori eseguiti su risorse Fargate devono fornire un ruolo di esecuzione. Per ulteriori informazioni, consulta AWS Batch esecuzione (ruolo IAM).

▬Tipo: stringa

Campo obbligatorio: no

La configurazione della piattaforma per i lavori eseguiti sulle risorse di Fargate. I processi in esecuzione su risorse EC2 non devono specificare questo parametro.

Tipo: oggetto FargatePlatformdi configurazione

Campo obbligatorio: no

L'immagine utilizzata per iniziare un lavoro. Questa stringa viene trasmessa direttamente al daemon Docker. Le immagini nel registro Docker Hub sono disponibili di default. Puoi anche specificare altri repository con repository-url/image:tag. Il nome può contenere un massimo di 255 lettere (maiuscole e minuscole); sono consentiti numeri, trattini, caratteri di sottolineatura, due punti, punti, barre e cancelletti. Questo parametro è mappato a Image nella sezione Crea un container dell'API remota Docker e al parametro IMAGE di docker run.

Tipo: stringa

Campo obbligatorio: sì

Il tipo di istanza da usare per un processo parallelo a più nodi. Attualmente tutti i gruppi di nodi in un processo parallelo a più nodi devono utilizzare lo stesso tipo di istanza. Questo parametro non è valido per i processi container a nodo singolo o per i lavori eseguiti su risorse Fargate.

▬Tipo: stringa

Campo obbligatorio: no

Quando registri una definizione di lavoro, puoi specificare un ruolo IAM. che fornisce al container del processo le autorizzazioni necessarie per chiamare le operazioni dell'API specificate nelle policy associate per conto dell'utente. Per ulteriori informazioni, consulta Ruoli IAM per le attività nella Guida per sviluppatori di Amazon Elastic Container Service.

▬Tipo: stringa

Campo obbligatorio: no

Modifiche specifiche di Linux che vengono applicate al container, ad esempio i dettagli per le mappature dei dispositivi.

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

Tipo: oggetto LinuxParameters

Campo obbligatorio: no

La specifica di configurazione del registro per il lavoro.

Questo parametro è mappato a LogConfig nella sezione Crea un container di API Docker Remote e l'opzione --log-driver a docker run. Per impostazione predefinita, i container utilizzano lo stesso driver di log utilizzato dal daemon Docker. Tuttavia, il contenitore può utilizzare un driver di registrazione diverso dal demone Docker specificando un driver di registro con questo parametro nella definizione del contenitore. Per utilizzare un driver di registrazione diverso per un contenitore, il sistema di registro deve essere configurato sull'istanza del contenitore o su un altro server di registro per fornire opzioni di registrazione remota. Per ulteriori informazioni sulle opzioni per diversi driver di log supportati, consulta Configure logging drivers (Configurazione dei driver di log) nella documentazione di Docker.

Questo parametro richiede la versione 1.18 o successiva di Docker Remote API sull'istanza di container. Per controllare la versione Docker Remote API nell'istanza di container, accedi all'istanza di container ed esegui il seguente comando: 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"
              }
            ]
        }
    ]
}

Tipo: oggetto LogConfiguration

Campo obbligatorio: no

Questo parametro è obsoleto, utilizzalo al suo posto. resourceRequirements

Il numero di MiB di memoria riservati per il lavoro.

Ad esempioresourceRequirements, se la definizione del processo contiene una sintassi simile alla seguente.

"containerProperties": {
  "memory": 512
}

La sintassi equivalente utilizzata resourceRequirements è la seguente.

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

Tipo: integer

Campo obbligatorio: sì

I punti di montaggio per i volumi di dati nel container. Questo parametro è mappato a Volumes nella sezione Create a container di Docker Remote API e l'opzione --volume a docker run.

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

Tipo: array di oggetti

Campo obbligatorio: no

La configurazione di rete per i lavori eseguiti su risorse Fargate. I processi in esecuzione su risorse EC2 non devono specificare questo parametro.

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

Tipo: array di oggetti

Campo obbligatorio: no

Se il parametro è true, al container vengono assegnati privilegi elevati nell'istanza di container host (simile all'utente root). Questo parametro è mappato a Privileged nella sezione Create a container di Docker Remote API e l'opzione --privileged a docker run. Questo parametro non è applicabile ai processi in esecuzione su risorse Fargate. Non fornirlo né specificarlo come falso.

"privileged": true|false

Tipo: Booleano

Campo obbligatorio: no

Se il parametro è true, al container viene assegnato l'accesso in sola lettura al file system radice. Questo parametro è mappato a ReadonlyRootfs nella sezione Create a container di Docker Remote API e l'opzione --read-only a docker run.

"readonlyRootFilesystem": true|false

Tipo: Booleano

Campo obbligatorio: no

Il tipo e la quantità di una risorsa da assegnare a un container. Le risorse supportate includono GPU, MEMORY e VCPU.

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

Tipo: array di oggetti

Campo obbligatorio: no

I segreti del lavoro che sono esposti come variabili di ambiente. Per ulteriori informazioni, consulta Specifica di dati sensibili.

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

Tipo: array di oggetti

Campo obbligatorio: no

Un elenco di valori ulimits da impostare nel container. Questo parametro è mappato a Ulimits nella sezione Create a container di Docker Remote API e l'opzione --ulimit a docker run.

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

Tipo: array di oggetti

Campo obbligatorio: no

Il nome utente per l'utilizzo all'interno del container. Questo parametro è mappato a User nella sezione Create a container di Docker Remote API e l'opzione --user a docker run.

"user": "string"

▬Tipo: stringa

Campo obbligatorio: no

Questo parametro è obsoleto, utilizzalo al suo posto. resourceRequirements

Il numero di vCPU prenotate per il container.

Come esempio di utilizzoresourceRequirements, se la definizione del processo contiene righe simili a queste:

"containerProperties": {
  "vcpus": 2
}

Le righe equivalenti utilizzate resourceRequirements sono le seguenti.

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

Tipo: integer

Campo obbligatorio: sì

Quando si registra una definizione di processo, è possibile specificare un elenco di volumi da passare al daemon Docker su un'istanza di container. Nelle proprietà del container sono consentiti i seguenti parametri:

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

Le proprietà delle risorse del Kubernetes pod di un lavoro.

Tipo: oggetto EksPodProperties

Campo obbligatorio: no

Le funzionalità della piattaforma richieste dalla definizione del lavoro. Se non viene specificato alcun valore, il valore predefinito è EC2. Per i lavori eseguiti su risorse Fargate, FARGATE è specificato.

▬Tipo: stringa

Valori validi: EC2 | FARGATE

Campo obbligatorio: no

Specifica se propagare i tag dal processo o dalla definizione del processo all'attività Amazon ECS corrispondente. Se non viene specificato alcun valore, i tag non vengono propagati. I tag possono essere propagati alle attività solo quando l'attività viene creata. Per i tag con lo stesso nome, viene data la priorità ai tag di processo anziché ai tag delle definizioni di processo. Se il numero totale di tag combinati del processo e della definizione del processo è superiore a 50, il lavoro viene FAILED spostato nello stato.

Tipo: Booleano

Campo obbligatorio: no

Quando si registra una definizione di processo parallelo multinodo, è necessario specificare un elenco di proprietà del nodo. Queste proprietà dei nodi definiscono il numero di nodi da utilizzare nel job, l'indice del nodo principale e i diversi intervalli di nodi da utilizzare. Se il lavoro viene eseguito su risorse Fargate, non è possibile specificare. nodeProperties Utilizza invece containerProperties. Di seguito sono indicate le proprietà del nodo consentite in una definizione di processo. Per ulteriori informazioni, consulta Lavori paralleli multinodo.

Tipo: oggetto NodeProperties

Campo obbligatorio: no

Quando si registra una definizione di processo, è possibile specificare una strategia per il numero di tentativi da utilizzare per i processi non riusciti inviati con questa definizione di processo. Qualsiasi strategia di nuovo tentativo specificata durante un'SubmitJoboperazione ha la precedenza sulla strategia di nuovo tentativo definita qui. Per impostazione predefinita, ogni processo viene tentato una sola volta. Se si specifica più di un tentativo, il processo viene ritentato se fallisce. Esempi di tentativo fallito includono il processo che restituisce un codice di uscita diverso da zero o l'istanza del contenitore viene terminata. Per ulteriori informazioni, consulta Ritentativi di lavoro automatizzati.

Tipo: oggetto RetryStrategy

Campo obbligatorio: no

La priorità di pianificazione per i lavori inviati con questa definizione di processo. Ciò riguarda solo i processi in coda di lavoro con una policy di ripartizione equa. I processi con una priorità di pianificazione più alta vengono pianificati prima dei lavori con una priorità di pianificazione inferiore.

Il valore minimo supportato è 0 e il valore massimo supportato è 9999.

Tipo: integer

Campo obbligatorio: no

Tag di coppia chiave-valore da associare alla definizione del processo. Per ulteriori informazioni, consulta Tagging delle risorse AWS Batch.

Tipo: mappatura stringa a stringa

Campo obbligatorio: no

È possibile configurare una durata di timeout per i processi in modo che, se un lavoro dura più a lungo, lo AWS Batch interrompa. Per ulteriori informazioni, consulta Job timeout. Se un lavoro viene interrotto a causa di un timeout, non viene ritentato. Qualsiasi configurazione di timeout specificata durante un'SubmitJoboperazione ha la precedenza sulla configurazione di timeout definita qui. Per ulteriori informazioni, consulta Job timeout.

Tipo: oggetto JobTimeout

Campo obbligatorio: no