batch/aws.sdk.kotlin.services.batch.model/ContainerProperties/Builder

Builder

Properties

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.

environment

var environment: List<KeyValuePair>?

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.

ephemeralStorage

var ephemeralStorage: 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 Fargate.

executionRoleArn

var executionRoleArn: String?

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

fargatePlatformConfiguration

var fargatePlatformConfiguration: FargatePlatformConfiguration?

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

image

var image: String?

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.

instanceType

var instanceType: String?

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.

jobRoleArn

var jobRoleArn: String?

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

linuxParameters

var linuxParameters: LinuxParameters?

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

logConfiguration

var logConfiguration: LogConfiguration?

The log configuration specification for the container.

memory

var ~~memory~~: Int?

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

mountPoints

var mountPoints: List<MountPoint>?

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.

networkConfiguration

var networkConfiguration: NetworkConfiguration?

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

privileged

var privileged: Boolean?

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.

readonlyRootFilesystem

var readonlyRootFilesystem: Boolean?

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.

repositoryCredentials

var repositoryCredentials: RepositoryCredentials?

The private repository authentication credentials to use.

resourceRequirements

var resourceRequirements: List<ResourceRequirement>?

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

runtimePlatform

var runtimePlatform: RuntimePlatform?

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

secrets

var secrets: List<Secret>?

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

ulimits

var ulimits: List<Ulimit>?

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.

user

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

vcpus

var ~~vcpus~~: Int?

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 EC2 resources, it specifies the number of vCPUs reserved for the job.

volumes

var volumes: List<Volume>?

A list of data volumes used in a job.