AWS::Batch::JobDefinition ContainerProperties

Container properties are used for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "Command" : [ String, ... ],
  "Environment" : [ Environment, ... ],
  "EphemeralStorage" : EphemeralStorage,
  "ExecutionRoleArn" : String,
  "FargatePlatformConfiguration" : FargatePlatformConfiguration,
  "Image" : String,
  "InstanceType" : String,
  "JobRoleArn" : String,
  "LinuxParameters" : LinuxParameters,
  "LogConfiguration" : LogConfiguration,
  "Memory" : Integer,
  "MountPoints" : [ MountPoints, ... ],
  "NetworkConfiguration" : NetworkConfiguration,
  "Privileged" : Boolean,
  "ReadonlyRootFilesystem" : Boolean,
  "RepositoryCredentials" : RepositoryCredentials,
  "ResourceRequirements" : [ ResourceRequirement, ... ],
  "RuntimePlatform" : RuntimePlatform,
  "Secrets" : [ Secret, ... ],
  "Ulimits" : [ Ulimit, ... ],
  "User" : String,
  "Vcpus" : Integer,
  "Volumes" : [ Volumes, ... ]
}

YAML


  Command: 
    - String
  Environment: 
    - Environment
  EphemeralStorage: 
    EphemeralStorage
  ExecutionRoleArn: String
  FargatePlatformConfiguration: 
    FargatePlatformConfiguration
  Image: String
  InstanceType: String
  JobRoleArn: String
  LinuxParameters: 
    LinuxParameters
  LogConfiguration: 
    LogConfiguration
  Memory: Integer
  MountPoints: 
    - MountPoints
  NetworkConfiguration: 
    NetworkConfiguration
  Privileged: Boolean
  ReadonlyRootFilesystem: Boolean
  RepositoryCredentials: 
    RepositoryCredentials
  ResourceRequirements: 
    - ResourceRequirement
  RuntimePlatform: 
    RuntimePlatform
  Secrets: 
    - Secret
  Ulimits: 
    - Ulimit
  User: String
  Vcpus: Integer
  Volumes: 
    - Volumes

Properties

Command

The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

Required: No

Type: Array of String

Update requires: No interruption

Environment

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

Important

We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Note

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that AWS Batch sets.

Required: No

Type: Array of Environment

Update requires: No interruption

EphemeralStorage

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate.

Required: No

Type: EphemeralStorage

Update requires: No interruption

ExecutionRoleArn

The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide.

Required: No

Type: String

Update requires: No interruption

FargatePlatformConfiguration

The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Required: No

Type: FargatePlatformConfiguration

Update requires: No interruption

Image

Required. The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag. It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

Note

Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

Images in Amazon ECR Public repositories use the full registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/registry_alias/my-web-app:latest.
Images in Amazon ECR repositories use the full registry and repository URI (for example, 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

Required: Yes

Type: String

Update requires: No interruption

InstanceType

The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.

Note

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

Required: No

Type: String

Update requires: No interruption

JobRoleArn

The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

Required: No

Type: String

Update requires: No interruption

LinuxParameters

Linux-specific modifications that are applied to the container, such as details for device mappings.

Required: No

Type: LinuxParameters

Update requires: No interruption

LogConfiguration

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Note

AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

Note

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

Required: No

Type: LogConfiguration

Update requires: No interruption

Memory

This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

Required: No

Type: Integer

Update requires: No interruption

MountPoints

The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Required: No

Type: Array of MountPoints

Update requires: No interruption

NetworkConfiguration

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Required: No

Type: NetworkConfiguration

Update requires: No interruption

Privileged

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false.

Note

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.

Required: No

Type: Boolean

Update requires: No interruption

ReadonlyRootFilesystem

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

Required: No

Type: Boolean

Update requires: No interruption

RepositoryCredentials

The private repository authentication credentials to use.

Required: No

Type: RepositoryCredentials

Update requires: No interruption

ResourceRequirements

The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

Required: No

Type: Array of ResourceRequirement

Update requires: No interruption

RuntimePlatform

An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Required: No

Type: RuntimePlatform

Update requires: No interruption

Secrets

The secrets for the container. For more information, see Specifying sensitive data in the AWS Batch User Guide.

Required: No

Type: Array of Secret

Update requires: No interruption

Ulimits

A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

Note

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Required: No

Type: Array of Ulimit

Update requires: No interruption

User

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

Required: No

Type: String

Update requires: No interruption

Vcpus

This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job.

Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

Required: No

Type: Integer

Update requires: No interruption

Volumes

A list of data volumes used in a job.

Required: No

Type: Array of Volumes

Update requires: No interruption

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

AuthorizationConfig

Device