ContainerDetail - AWS Batch

ContainerDetail

An object representing the details of a container that is part of a job.

Contents

command

The command that is passed to the container.

Type: Array of strings

Required: No

containerInstanceArn

The Amazon Resource Name (ARN) of the container instance on which the container is running.

Type: String

Required: No

environment

The environment variables to pass to a container.

Note

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

Type: Array of KeyValuePair objects

Required: No

executionRoleArn

The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more information, see AWS Batch execution IAM role.

Type: String

Required: No

exitCode

The exit code to return upon completion.

Type: Integer

Required: No

image

The image used to start the container.

Type: String

Required: No

instanceType

The instance type of the underlying host infrastructure of a multi-node parallel job.

Type: String

Required: No

jobRoleArn

The Amazon Resource Name (ARN) associated with the job upon execution.

Type: String

Required: No

linuxParameters

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

Type: LinuxParameters object

Required: No

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 may 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). Additional log drivers may be available in future releases of the Amazon ECS container agent.

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 into 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.

Type: LogConfiguration object

Required: No

logStreamName

The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

Type: String

Required: No

memory

The number of MiB of memory reserved for the job. This is a required parameter.

Type: Integer

Required: No

mountPoints

The mount points for data volumes in your container.

Type: Array of MountPoint objects

Required: No

networkInterfaces

The network interfaces associated with the job.

Type: Array of NetworkInterface objects

Required: No

privileged

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user).

Type: Boolean

Required: No

readonlyRootFilesystem

When this parameter is true, the container is given read-only access to its root file system.

Type: Boolean

Required: No

reason

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

Type: String

Required: No

resourceRequirements

The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.

Type: Array of ResourceRequirement objects

Required: No

secrets

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

Type: Array of Secret objects

Required: No

taskArn

The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.

Type: String

Required: No

ulimits

A list of ulimit values to set in the container.

Type: Array of Ulimit objects

Required: No

user

The user name to use inside the container.

Type: String

Required: No

vcpus

The number of VCPUs allocated for the job. This is a required parameter.

Type: Integer

Required: No

volumes

A list of volumes associated with the job.

Type: Array of Volume objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: