/AWS1/CL_BTCCONTAINERPRPS

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

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_image TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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.

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..amazonaws.com/).

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

iv_vcpus TYPE /AWS1/BTCINTEGER /AWS1/BTCINTEGER

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.

iv_memory TYPE /AWS1/BTCINTEGER /AWS1/BTCINTEGER

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.

it_command TYPE /AWS1/CL_BTCSTRINGLIST_W=>TT_STRINGLIST TT_STRINGLIST

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.

iv_jobrolearn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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.

iv_executionrolearn TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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.

it_volumes TYPE /AWS1/CL_BTCVOLUME=>TT_VOLUMES TT_VOLUMES

A list of data volumes used in a job.

it_environment TYPE /AWS1/CL_BTCKEYVALUEPAIR=>TT_ENVIRONMENTVARIABLES TT_ENVIRONMENTVARIABLES

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.

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

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

it_mountpoints TYPE /AWS1/CL_BTCMOUNTPOINT=>TT_MOUNTPOINTS TT_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.

iv_readonlyrootfilesystem TYPE /AWS1/BTCBOOLEAN /AWS1/BTCBOOLEAN

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.

iv_privileged TYPE /AWS1/BTCBOOLEAN /AWS1/BTCBOOLEAN

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.

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

it_ulimits TYPE /AWS1/CL_BTCULIMIT=>TT_ULIMITS TT_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.

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

iv_user TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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.

iv_instancetype TYPE /AWS1/BTCSTRING /AWS1/BTCSTRING

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.

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

it_resourcerequirements TYPE /AWS1/CL_BTCRESRCREQUIREMENT=>TT_RESOURCEREQUIREMENTS TT_RESOURCEREQUIREMENTS

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

io_linuxparameters TYPE REF TO /AWS1/CL_BTCLINUXPARAMETERS /AWS1/CL_BTCLINUXPARAMETERS

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

io_logconfiguration TYPE REF TO /AWS1/CL_BTCLOGCONFIGURATION /AWS1/CL_BTCLOGCONFIGURATION

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.

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"

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.

it_secrets TYPE /AWS1/CL_BTCSECRET=>TT_SECRETLIST TT_SECRETLIST

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

io_networkconfiguration TYPE REF TO /AWS1/CL_BTCNETWORKCONF /AWS1/CL_BTCNETWORKCONF

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

io_fargateplatformconf TYPE REF TO /AWS1/CL_BTCFARGATEPLATFORMC00 /AWS1/CL_BTCFARGATEPLATFORMC00

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

iv_enableexecutecommand TYPE /AWS1/BTCBOOLEAN /AWS1/BTCBOOLEAN

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.

io_ephemeralstorage TYPE REF TO /AWS1/CL_BTCEPHEMERALSTORAGE /AWS1/CL_BTCEPHEMERALSTORAGE

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.

io_runtimeplatform TYPE REF TO /AWS1/CL_BTCRUNTIMEPLATFORM /AWS1/CL_BTCRUNTIMEPLATFORM

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

io_repositorycredentials TYPE REF TO /AWS1/CL_BTCREPOSITORYCREDS /AWS1/CL_BTCREPOSITORYCREDS

The private repository authentication credentials to use.

---

Queryable Attributes

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.

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..amazonaws.com/).

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

Accessible with the following methods

Method	Description
GET_IMAGE()	Getter for IMAGE, with configurable default
ASK_IMAGE()	Getter for IMAGE w/ exceptions if field has no value
HAS_IMAGE()	Determine if IMAGE has a value

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.

Accessible with the following methods

Method	Description
GET_VCPUS()	Getter for VCPUS, with configurable default
ASK_VCPUS()	Getter for VCPUS w/ exceptions if field has no value
HAS_VCPUS()	Determine if VCPUS has a value

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.

Accessible with the following methods

Method	Description
GET_MEMORY()	Getter for MEMORY, with configurable default
ASK_MEMORY()	Getter for MEMORY w/ exceptions if field has no value
HAS_MEMORY()	Determine if MEMORY has a value

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.

Accessible with the following methods

Method	Description
GET_COMMAND()	Getter for COMMAND, with configurable default
ASK_COMMAND()	Getter for COMMAND w/ exceptions if field has no value
HAS_COMMAND()	Determine if COMMAND has a value

jobRoleArn

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.

Accessible with the following methods

Method	Description
GET_JOBROLEARN()	Getter for JOBROLEARN, with configurable default
ASK_JOBROLEARN()	Getter for JOBROLEARN w/ exceptions if field has no value
HAS_JOBROLEARN()	Determine if JOBROLEARN has a value

executionRoleArn

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.

Accessible with the following methods

Method	Description
GET_EXECUTIONROLEARN()	Getter for EXECUTIONROLEARN, with configurable default
ASK_EXECUTIONROLEARN()	Getter for EXECUTIONROLEARN w/ exceptions if field has no va
HAS_EXECUTIONROLEARN()	Determine if EXECUTIONROLEARN has a value

volumes

A list of data volumes used in a job.

Accessible with the following methods

Method	Description
GET_VOLUMES()	Getter for VOLUMES, with configurable default
ASK_VOLUMES()	Getter for VOLUMES w/ exceptions if field has no value
HAS_VOLUMES()	Determine if VOLUMES has a value

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.

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

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

Accessible with the following methods

Method	Description
GET_ENVIRONMENT()	Getter for ENVIRONMENT, with configurable default
ASK_ENVIRONMENT()	Getter for ENVIRONMENT w/ exceptions if field has no value
HAS_ENVIRONMENT()	Determine if ENVIRONMENT has a value

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.

Accessible with the following methods

Method	Description
GET_MOUNTPOINTS()	Getter for MOUNTPOINTS, with configurable default
ASK_MOUNTPOINTS()	Getter for MOUNTPOINTS w/ exceptions if field has no value
HAS_MOUNTPOINTS()	Determine if MOUNTPOINTS has a value

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.

Accessible with the following methods

Method	Description
GET_READONLYROOTFILESYSTEM()	Getter for READONLYROOTFILESYSTEM, with configurable default
ASK_READONLYROOTFILESYSTEM()	Getter for READONLYROOTFILESYSTEM w/ exceptions if field has
HAS_READONLYROOTFILESYSTEM()	Determine if READONLYROOTFILESYSTEM has a value

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.

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

Accessible with the following methods

Method	Description
GET_PRIVILEGED()	Getter for PRIVILEGED, with configurable default
ASK_PRIVILEGED()	Getter for PRIVILEGED w/ exceptions if field has no value
HAS_PRIVILEGED()	Determine if PRIVILEGED has a value

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.

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

Accessible with the following methods

Method	Description
GET_ULIMITS()	Getter for ULIMITS, with configurable default
ASK_ULIMITS()	Getter for ULIMITS w/ exceptions if field has no value
HAS_ULIMITS()	Determine if ULIMITS has a value

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.

Accessible with the following methods

Method	Description
GET_USER()	Getter for USER, with configurable default
ASK_USER()	Getter for USER w/ exceptions if field has no value
HAS_USER()	Determine if USER has a value

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.

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

Accessible with the following methods

Method	Description
GET_INSTANCETYPE()	Getter for INSTANCETYPE, with configurable default
ASK_INSTANCETYPE()	Getter for INSTANCETYPE w/ exceptions if field has no value
HAS_INSTANCETYPE()	Determine if INSTANCETYPE has a value

resourceRequirements

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

Accessible with the following methods

Method	Description
GET_RESOURCEREQUIREMENTS()	Getter for RESOURCEREQUIREMENTS, with configurable default
ASK_RESOURCEREQUIREMENTS()	Getter for RESOURCEREQUIREMENTS w/ exceptions if field has n
HAS_RESOURCEREQUIREMENTS()	Determine if RESOURCEREQUIREMENTS has a value

linuxParameters

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

Accessible with the following methods

Method	Description
GET_LINUXPARAMETERS()	Getter for LINUXPARAMETERS

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.

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"

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.

Accessible with the following methods

Method	Description
GET_LOGCONFIGURATION()	Getter for LOGCONFIGURATION

secrets

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

Accessible with the following methods

Method	Description
GET_SECRETS()	Getter for SECRETS, with configurable default
ASK_SECRETS()	Getter for SECRETS w/ exceptions if field has no value
HAS_SECRETS()	Determine if SECRETS has a value

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.

Accessible with the following methods

Method	Description
GET_NETWORKCONFIGURATION()	Getter for NETWORKCONFIGURATION

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.

Accessible with the following methods

Method	Description
GET_FARGATEPLATFORMCONF()	Getter for FARGATEPLATFORMCONFIGURATION

enableExecuteCommand

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.

Accessible with the following methods

Method	Description
GET_ENABLEEXECUTECOMMAND()	Getter for ENABLEEXECUTECOMMAND, with configurable default
ASK_ENABLEEXECUTECOMMAND()	Getter for ENABLEEXECUTECOMMAND w/ exceptions if field has n
HAS_ENABLEEXECUTECOMMAND()	Determine if ENABLEEXECUTECOMMAND has a value

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.

Accessible with the following methods

Method	Description
GET_EPHEMERALSTORAGE()	Getter for EPHEMERALSTORAGE

runtimePlatform

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

Accessible with the following methods

Method	Description
GET_RUNTIMEPLATFORM()	Getter for RUNTIMEPLATFORM

repositoryCredentials

The private repository authentication credentials to use.

Accessible with the following methods

Method	Description
GET_REPOSITORYCREDENTIALS()	Getter for REPOSITORYCREDENTIALS