ContainerDetail

An object that represents the details of a container that's part of a job.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The command that's passed to the container.

Link copied to clipboard

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

Link copied to clipboard

Determines whether execute command functionality is turned on for this task. If true, execute command functionality is turned on all the containers in the task.

Link copied to clipboard

The environment variables to pass to a container.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The exit code returned upon completion.

Link copied to clipboard

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

Link copied to clipboard

The image used to start the container.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The log configuration specification for the container.

Link copied to clipboard

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.

Link copied to clipboard
val memory: Int?

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.

Link copied to clipboard

The mount points for data volumes in your container.

Link copied to clipboard

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

Link copied to clipboard

The network interfaces that are associated with the job.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The private repository authentication credentials to use.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
val user: String?

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.

Link copied to clipboard
val vcpus: Int?

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.

Link copied to clipboard

A list of volumes that are associated with the job.

Functions

Link copied to clipboard
inline fun copy(block: ContainerDetail.Builder.() -> Unit = {}): ContainerDetail
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String