Skip to content

/AWS1/CL_ECSLINUXPARAMETERS

The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.

CONSTRUCTOR

IMPORTING

Optional arguments:

io_capabilities TYPE REF TO /AWS1/CL_ECSKERNELCAPABILITIES /AWS1/CL_ECSKERNELCAPABILITIES

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.

it_devices TYPE /AWS1/CL_ECSDEVICE=>TT_DEVICESLIST TT_DEVICESLIST

Any host devices to expose to the container. This parameter maps to Devices in the docker container create command and the --device option to docker run.

If you're using tasks that use the Fargate launch type, the devices parameter isn't supported.

iv_initprocessenabled TYPE /AWS1/ECSBOXEDBOOLEAN /AWS1/ECSBOXEDBOOLEAN

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 in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

iv_sharedmemorysize TYPE /AWS1/ECSBOXEDINTEGER /AWS1/ECSBOXEDINTEGER

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

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

it_tmpfs TYPE /AWS1/CL_ECSTMPFS=>TT_TMPFSLIST TT_TMPFSLIST

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

If you're using tasks that use the Fargate launch type, the tmpfs parameter isn't supported.

iv_maxswap TYPE /AWS1/ECSBOXEDINTEGER /AWS1/ECSBOXEDINTEGER

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.

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.

If you're using tasks that use the Fargate launch type, the maxSwap parameter isn't supported.

If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't supported.

iv_swappiness TYPE /AWS1/ECSBOXEDINTEGER /AWS1/ECSBOXEDINTEGER

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.

If you're using tasks that use the Fargate launch type, the swappiness parameter isn't supported.

If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't supported.


Queryable Attributes

capabilities

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.

Accessible with the following methods

Method Description
GET_CAPABILITIES() Getter for CAPABILITIES

devices

Any host devices to expose to the container. This parameter maps to Devices in the docker container create command and the --device option to docker run.

If you're using tasks that use the Fargate launch type, the devices parameter isn't supported.

Accessible with the following methods

Method Description
GET_DEVICES() Getter for DEVICES, with configurable default
ASK_DEVICES() Getter for DEVICES w/ exceptions if field has no value
HAS_DEVICES() Determine if DEVICES has a value

initProcessEnabled

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 in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

Accessible with the following methods

Method Description
GET_INITPROCESSENABLED() Getter for INITPROCESSENABLED, with configurable default
ASK_INITPROCESSENABLED() Getter for INITPROCESSENABLED w/ exceptions if field has no
HAS_INITPROCESSENABLED() Determine if INITPROCESSENABLED has a value

sharedMemorySize

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

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

Accessible with the following methods

Method Description
GET_SHAREDMEMORYSIZE() Getter for SHAREDMEMORYSIZE, with configurable default
ASK_SHAREDMEMORYSIZE() Getter for SHAREDMEMORYSIZE w/ exceptions if field has no va
HAS_SHAREDMEMORYSIZE() Determine if SHAREDMEMORYSIZE has a value

tmpfs

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

If you're using tasks that use the Fargate launch type, the tmpfs parameter isn't supported.

Accessible with the following methods

Method Description
GET_TMPFS() Getter for TMPFS, with configurable default
ASK_TMPFS() Getter for TMPFS w/ exceptions if field has no value
HAS_TMPFS() Determine if TMPFS has a value

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.

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.

If you're using tasks that use the Fargate launch type, the maxSwap parameter isn't supported.

If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't supported.

Accessible with the following methods

Method Description
GET_MAXSWAP() Getter for MAXSWAP, with configurable default
ASK_MAXSWAP() Getter for MAXSWAP w/ exceptions if field has no value
HAS_MAXSWAP() Determine if MAXSWAP has a value

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.

If you're using tasks that use the Fargate launch type, the swappiness parameter isn't supported.

If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't supported.

Accessible with the following methods

Method Description
GET_SWAPPINESS() Getter for SWAPPINESS, with configurable default
ASK_SWAPPINESS() Getter for SWAPPINESS w/ exceptions if field has no value
HAS_SWAPPINESS() Determine if SWAPPINESS has a value