Referencia: parámetros de definición de trabajo para ContainerProperties

Al registrar una definición de trabajo, es necesario especificar un nombre. El nombre puede tener una longitud máxima de 128 caracteres. Puede contener letras mayúsculas y minúsculas, números, guiones (-) y guiones bajos (_). A la primera definición de trabajo registrado con ese nombre se le da asigna la revisión 1. A las definiciones de trabajo posteriores registradas con el mismo nombre se les asignan números de revisión en orden ascendente.

Tipo: cadena

Obligatorio: sí

Al registrar una definición de trabajo, es necesario especificar el tipo de trabajo. Si el trabajo se ejecuta en recursos de Fargate, entonces multinode no es compatible. Para obtener más información sobre los trabajos paralelos de varios nodos, consulte Crear una definición de trabajo paralelo de varios nodos.

Tipo: cadena

Valores válidos: container | multinode

Obligatorio: sí

Al enviar un trabajo, es posible especificar parámetros que sustituyan los marcadores de posición o ignoren los parámetros de definición de trabajo predeterminados. Los parámetros de las solicitudes de envío de trabajo prevalecen sobre los predeterminados de la definición de trabajo. Esto significa que puede usar la misma definición de trabajo para varios trabajos que usen el mismo formato. También puede cambiar mediante programación los valores del comando en el momento del envío.

Tipo: mapa de cadena a cadena

Obligatorio: no

Al registrar una definición de trabajo, es posible utilizar marcadores de posición de sustitución de parámetros en el campo command de las propiedades de un contenedor de trabajo. La sintaxis es la siguiente.

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

En el ejemplo anterior, hay marcadores de posición de sustitución de parámetros Ref::inputfile, Ref::codec y Ref::outputfile en el comando. Puede usar el objeto parameters de la definición de trabajo para establecer valores predeterminados para estos marcadores de posición. Por ejemplo, para definir un valor predeterminado para el marcador de posición Ref::codec, especifique lo siguiente en la definición del trabajo:

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

Cuando esta definición de trabajo se envíe para su ejecución, el argumento Ref::codec del comando para el contenedor se sustituirá por el valor predeterminado, mp4.

El comando que se transfiere al contenedor. Este parámetro se asigna a Cmd en la sección Crear un contenedor de la API remota de Docker y el parámetro COMMAND se corresponde con docker run. Para obtener más información sobre el parámetro CMD de Docker, consulte https://docs.docker.com/engine/reference/builder/#cmd.

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

Tipo: matriz de cadenas

Requerido: no

Las variables de entorno a transferir a un contenedor. Este parámetro se corresponde con Env en la sección Crear un contenedor de la API remota de Docker y con la opción --env de docker run.

Tipo: matriz de pares clave-valor

Obligatorio: no

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

Al registrar una definición de trabajo, es posible especificar un rol de IAM. El rol le concede al agente de contenedor de Amazon ECS permisos para llamar a las acciones de la API que se especifican en sus políticas asociadas, en nombre de quien registra la definición de trabajo. Para los trabajos que se ejecutan en recursos de Fargate, debe proporcionar un rol de ejecución. Para obtener más información, consulte Rol de ejecución de IAM AWS Batch.

Tipo: string

Obligatorio: no

La configuración de la plataforma para trabajos que se ejecutan en recursos de Fargate. Los trabajos que se ejecutan en los recursos de EC2 no deben especificar este parámetro.

Tipo: objeto FargatePlatformConfiguration

Obligatorio: no

La imagen que se utiliza para iniciar un trabajo. Esta cadena se transfiere directamente al daemon de Docker. Las imágenes del registro de Docker Hub están disponibles de forma predeterminada. También es posible especificar otros repositorios con repository-url/image:tag. Se permiten hasta 255 letras (mayúsculas y minúsculas), números, guiones, caracteres de subrayado, comas, puntos, barras diagonales y signos numéricos. Este parámetro se asigna a Image en la sección Crear un contenedor de la API remota de Docker y el parámetro IMAGE de docker run.

Tipo: cadena

Obligatorio: sí

El tipo de instancia que se va a utilizar para un trabajo en paralelo de varios nodos. Todos los grupos de nodos de un trabajo paralelo de varios nodos deben utilizar el mismo tipo de instancia. Este parámetro no es aplicable a trabajos de contenedor de un solo nodo o para trabajos que se ejecutan en recursos de Fargate.

Tipo: cadena

Obligatorio: no

Al registrar una definición de trabajo, es posible especificar un rol de IAM. El rol le concede al contenedor de trabajo permisos para llamar a las acciones de la API que se especifican en sus políticas asociadas, en nombre de quien registra la definición de trabajo. Para obtener más información, consulte Roles de IAM para tareas en la Guía para desarrolladores de Amazon Elastic Container Service.

Tipo: cadena

Obligatorio: no

Modificaciones específicas de Linux que se aplican al contenedor, como los detalles de asignación de dispositivos.

"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: objeto LinuxParameters

Obligatorio: no

La especificación de configuración de registro para el trabajo.

Este parámetro se corresponde con LogConfig en la sección Crear un contenedor de la API remota de Docker y la opción --log-driver se corresponde con docker run. De forma predeterminada, los contenedores usan el mismo controlador de registro que el daemon de Docker. No obstante, el contenedor puede usar un controlador de registro distinto del daemon de Docker especificando un controlador de registro con este parámetro en la definición de contenedor. Para utilizar un controlador de registro distinto para un contenedor, el sistema de registro se debe configurar correctamente en la instancia de contenedor o en un servidor de registro distinto para opciones de registro remotas. Para obtener más información acerca de las opciones para los distintos controladores de registro admitidos, consulte Configurar controladores de registro en la documentación de Docker.

Este parámetro requiere la versión 1.18 de la API remota de Docker o superior en su instancia de contenedor. Para comprobar la versión de la API remota de Docker en su instancia de contenedor, inicie sesión en su instancia de contenedor y ejecute el comando siguiente: 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: objeto LogConfiguration

Obligatorio: no

Este parámetro ha quedado obsoleto, utilice resourceRequirements en su lugar.

El número de MiB de memoria que reservar para el trabajo.

Como ejemplo de cómo usar resourceRequirements, si la definición de su trabajo contiene una sintaxis similar a la siguiente.

"containerProperties": {
  "memory": 512
}

La sintaxis equivalente a través de resourceRequirements es de la siguiente manera.

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

Tipo: entero

Obligatorio: sí

Los puntos de montaje para los volúmenes de datos del contenedor. Este parámetro se corresponde con Volumes en la sección Crear un contenedor de la API remota de Docker y con la opción --volume de docker run.

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

Tipo: matriz de objetos

Requerido: no

La configuración de red para los trabajos que se ejecutan en recursos de Fargate. Los trabajos que se ejecutan en los recursos de EC2 no deben especificar este parámetro.

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

Tipo: matriz de objetos

Requerido: no

Cuando este parámetro es verdadero, al contenedor se le conceden permisos elevados en la instancia de contenedor de host, similares a los de un usuario root. Este parámetro se corresponde con Privileged en la sección Crear un contenedor de la API remota de Docker y con la opción --privileged de docker run. Este parámetro no es aplicable a trabajos que se ejecutan en recursos de Fargate. No lo proporcione ni lo especifique como falso.

"privileged": true|false

Tipo: Booleano

Obligatorio: no

Cuando este parámetro es verdadero, al contenedor se le concede acceso de solo lectura a su sistema de archivos raíz. Este parámetro se corresponde con ReadonlyRootfs en la sección Crear un contenedor de la API remota de Docker y con la opción --read-only de docker run.

"readonlyRootFilesystem": true|false

Tipo: Booleano

Obligatorio: no

El tipo y la cantidad de un recurso para asignar a un contenedor. Los recursos admitidos incluyen GPU, MEMORY, y VCPU.

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

Tipo: matriz de objetos

Obligatorio: no

Los secretos del trabajo que se exponen como variables de entorno. Para obtener más información, consulte Especificar información confidencial.

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

Tipo: matriz de objetos

Requerido: no

Una lista de valores para ulimits a definir en el contenedor. Este parámetro se corresponde con Ulimits en la sección Crear un contenedor de la API remota de Docker y con la opción --ulimit de docker run.

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

Tipo: matriz de objetos

Obligatorio: no

El nombre de usuario que utilizar dentro del contenedor. Este parámetro se corresponde con User en la sección Crear un contenedor de la API remota de Docker y con la opción --user de docker run.

"user": "string"

Tipo: cadena

Obligatorio: no

Este parámetro ha quedado obsoleto, utilice resourceRequirements en su lugar.

El número de vCPU reservado para el contenedor.

Como ejemplo sobre el uso de resourceRequirements, si la definición de su trabajo contiene líneas similares a las siguientes:

"containerProperties": {
  "vcpus": 2
}

Las líneas equivalentes que utilizan resourceRequirements son las siguientes.

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

Tipo: entero

Obligatorio: sí

Al registrar una definición de trabajos, puede especificar una lista de los volúmenes que se pasan al daemon de Docker en una instancia de contenedor. Los siguientes parámetros están permitidos en las propiedades de contenedor:

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

Las propiedades de los recursos del pod de Kubernetes de un trabajo.

Tipo: objeto EksPodProperties

Obligatorio: no

Las capacidades de plataforma requeridas por la definición de trabajo. Si no se especifica ningún valor, el valor predeterminado es EC2. Para los trabajos que se ejecutan en recursos de Fargate, se especifica FARGATE.

Tipo: cadena

Valores válidos: EC2 | FARGATE

Obligatorio: no

Especifica si se van a propagar las etiquetas desde el trabajo o la definición del trabajo a la tarea de Amazon ECS correspondiente. Si no se especifica ningún valor, las etiquetas no se propagan. Las etiquetas solo se pueden propagar a las tareas cuando se crea la tarea. En el caso de etiquetas con el mismo nombre, las etiquetas de trabajo tienen prioridad sobre las etiquetas de definiciones de trabajo. Si el número total de etiquetas combinadas del trabajo y la definición del trabajo es superior a 50, el trabajo se mueve al estado FAILED.

Tipo: Booleano

Obligatorio: no

Al registrar una definición de trabajo paralelo de varios nodos, debe especificar una lista de propiedades de nodos. Estas propiedades de los nodos definen el número de nodos que se van a utilizar en el trabajo, el índice de nodos principales y los diferentes rangos de nodos que se van a utilizar. Si el trabajo se ejecuta en recursos de Fargate, no puede especificar nodeProperties. En su lugar, utilice containerProperties. En una definición de trabajo, se permiten las siguientes propiedades de nodo. Para obtener más información, consulte Trabajos paralelos de varios nodos.

Tipo: objeto NodeProperties

Obligatorio: no

Al registrar una definición de trabajo, se puede especificar una estrategia de reintento para aplicarla a los trabajos fallidos que se envíen con esta definición de trabajo. Cualquier estrategia de reintento que se especifique durante una operación SubmitJob anula la estrategia de reintento definida aquí. De forma predeterminada, cada trabajo se intenta una vez. Si especifica más de un intento, el trabajo se vuelve a intentar si falla. Algunos ejemplos de intentos fallidos son que el trabajo devuelva un código de salida distinto de cero o que la instancia de contenedor se termine. Para obtener más información, consulte Reintentos automáticos de trabajo.

Tipo: objeto RetryStrategy

Obligatorio: no

La prioridad de programación de los trabajos que se enviaron con esta definición de trabajo. Esto solo afecta a las colas de trabajo con una política de reparto justo. Los trabajos con una prioridad de programación más alta se programan antes que los trabajos con una prioridad de programación más baja.

El valor mínimo admitido es 0 y el valor máximo admitido es 9999.

Tipo: entero

Obligatorio: no

Etiquetas de pares clave-valor para asociarlas a la definición del trabajo. Para obtener más información, consulte Etiquetar los recursos de AWS Batch.

Tipo: mapa de cadena a cadena

Obligatorio: no

Puede configurar una duración de tiempo de espera para sus trabajos de modo que si un trabajo se ejecuta durante más tiempo, AWS Batch lo finaliza. Para obtener más información, consulte Tiempos de espera de trabajo. Si un trabajo se termina debido a que se ha agotado el tiempo de espera, no se vuelve a intentar. Cualquier configuración de tiempo de espera que se especifique durante una operación SubmitJob sustituye la configuración de tiempo de espera definida aquí. Para obtener más información, consulte Tiempos de espera de trabajo.

Tipo: objeto JobTimeout

Obligatorio: no