ContainerDetail

Gets and sets the property Command.

The command that's passed to the container.

Gets and sets the property ContainerInstanceArn.

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

Gets and sets the property Environment.

The environment variables to pass to a container.

Gets and sets the property EphemeralStorage.

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

Gets and sets the property ExecutionRoleArn.

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

Gets and sets the property ExitCode.

The exit code returned upon completion.

Gets and sets the property 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.

Gets and sets the property Image.

The image used to start the container.

Gets and sets the property InstanceType.

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

Gets and sets the property JobRoleArn.

The Amazon Resource Name (ARN) that's associated with the job when run.

Gets and sets the property LinuxParameters.

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

Gets and sets the property 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, alternatively, it must be configured 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.

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"

Gets and sets the property LogStreamName.

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

Gets and sets the property Memory.

For jobs running on Amazon EC2 resources that didn't specify memory requirements using resourceRequirements, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.

Gets and sets the property MountPoints.

The mount points for data volumes in your container.

Gets and sets the property 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.

Gets and sets the property NetworkInterfaces.

The network interfaces that are associated with the job.

Gets and sets the property Privileged.

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

Gets and sets the property 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.

Gets and sets the property Reason.

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

Gets and sets the property RepositoryCredentials.

The private repository authentication credentials to use.

Gets and sets the property ResourceRequirements.

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

Gets and sets the property RuntimePlatform.

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

Gets and sets the property Secrets.

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

Gets and sets the property TaskArn.

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

Gets and sets the property Ulimits.

A list of ulimit values 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.

Gets and sets the property 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.

Gets and sets the property Vcpus.

The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both the vcpus and resourceRequirements object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.

Gets and sets the property Volumes.

A list of volumes that are associated with the job.