AWS::Batch::JobDefinition LinuxParameters

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Devices" : [ Device, ... ],
  "InitProcessEnabled" : Boolean,
  "MaxSwap" : Integer,
  "SharedMemorySize" : Integer,
  "Swappiness" : Integer,
  "Tmpfs" : [ Tmpfs, ... ]
}

YAML

  Devices: 
    - Device
  InitProcessEnabled: Boolean
  MaxSwap: Integer
  SharedMemorySize: Integer
  Swappiness: Integer
  Tmpfs: 
    - Tmpfs

Properties

Devices

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

Required: No

Type: List of Device

Update requires: No interruption

InitProcessEnabled

If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 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"

Required: No

Type: Boolean

Update requires: No interruption

MaxSwap

The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.

Required: No

Type: Integer

Update requires: No interruption

SharedMemorySize

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

Required: No

Type: Integer

Update requires: No interruption

Swappiness

This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.

Required: No

Type: Integer

Update requires: No interruption

Tmpfs

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

Required: No

Type: List of Tmpfs

Update requires: No interruption