AWS CDK Reference

Appearance

v2.274.0

LinuxParametersProps Struct ​

The properties for defining Linux-specific options that are applied to the container.

Source
aws-ecs/lib/linux-parameters.ts
Type last changed
v2.41.0 · 8 Sep 2022

Example ​

ts
declare const taskDefinition: ecs.TaskDefinition;

taskDefinition.addContainer('container', {
  image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
  memoryLimitMiB: 1024,
  linuxParameters: new ecs.LinuxParameters(this, 'LinuxParameters', {
    initProcessEnabled: true,
    sharedMemorySize: 1024,
    maxSwap: Size.mebibytes(5000),
    swappiness: 90,
  }),
});

Properties ​

initProcessEnabledbooleaninit_process_enabledboolinitProcessEnabledBooleanInitProcessEnabledboolInitProcessEnabled*bool= false#
Specifies whether to run an init process inside the container that forwards signals and reaps processes.
maxSwapSizemax_swapSizemaxSwapSizeMaxSwapSizeMaxSwapSize= No swap.#
The total amount of swap memory a container can use.

This parameter will be translated to the --memory-swap option to docker run.

This parameter is only supported when you are using the EC2 launch type. Accepted values are positive integers.

sharedMemorySizenumbershared_memory_sizeint | floatsharedMemorySizeNumberSharedMemorySizedoubleSharedMemorySize*float64= No shared memory.#
The value for the size of the /dev/shm volume.
swappinessnumberswappinessint | floatswappinessNumberSwappinessdoubleSwappiness*float64= 60#
This allows you to tune a container's memory swappiness behavior.
notes

This parameter maps to the --memory-swappiness option to docker run. The swappiness relates to the kernel's tendency to swap memory. A value of 0 will cause swapping to not happen unless absolutely necessary. A value of 100 will cause pages to be swapped very aggressively.

This parameter is only supported when you are using the EC2 launch type. Accepted values are whole numbers between 0 and 100. If a value is not specified for maxSwap then this parameter is ignored.