AWS::ECS::TaskDefinition LinuxParameters
The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Capabilities" :
KernelCapabilities
, "Devices" :[ Device, ... ]
, "InitProcessEnabled" :Boolean
, "MaxSwap" :Integer
, "SharedMemorySize" :Integer
, "Swappiness" :Integer
, "Tmpfs" :[ Tmpfs, ... ]
}
YAML
Capabilities:
KernelCapabilities
Devices:- Device
InitProcessEnabled:Boolean
MaxSwap:Integer
SharedMemorySize:Integer
Swappiness:Integer
Tmpfs:- Tmpfs
Properties
Capabilities
-
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
Note
For tasks that use the Fargate launch type,
capabilities
is supported for all platform versions but theadd
parameter is only supported if using platform version 1.4.0 or later.Required: No
Type: KernelCapabilities
Update requires: Replacement
Devices
-
Any host devices to expose to the container. This parameter maps to
Devices
in tthe docker conainer create command and the--device
option to docker run.Note
If you're using tasks that use the Fargate launch type, the
devices
parameter isn't supported.Required: No
Type: Array of Device
Update requires: Replacement
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}}'
Required: No
Type: Boolean
Update requires: Replacement
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 themaxSwap
value.If a
maxSwap
value of0
is specified, the container will not use swap. Accepted values are0
or any positive integer. If themaxSwap
parameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwap
value must be set for theswappiness
parameter to be used.Note
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.Required: No
Type: Integer
Update requires: Replacement
-
The value for the size (in MiB) of the
/dev/shm
volume. This parameter maps to the--shm-size
option to docker run.Note
If you are using tasks that use the Fargate launch type, the
sharedMemorySize
parameter is not supported.Required: No
Type: Integer
Update requires: Replacement
Swappiness
-
This allows you to tune a container's memory swappiness behavior. A
swappiness
value of0
will cause swapping to not happen unless absolutely necessary. Aswappiness
value of100
will cause pages to be swapped very aggressively. Accepted values are whole numbers between0
and100
. If theswappiness
parameter is not specified, a default value of60
is used. If a value is not specified formaxSwap
then this parameter is ignored. This parameter maps to the--memory-swappiness
option to docker run.Note
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.Required: No
Type: Integer
Update requires: Replacement
Tmpfs
-
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfs
option to docker run.Note
If you're using tasks that use the Fargate launch type, the
tmpfs
parameter isn't supported.Required: No
Update requires: Replacement