AWS CDK Reference

Appearance

v2.274.0

LinuxParametersProps Struct ​

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

Source
aws-batch/lib/linux-parameters.ts
Type last changed
v2.96.0 · 13 Sep 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_batch as batch } from 'aws-cdk-lib';

declare const size: cdk.Size;
const linuxParametersProps: batch.LinuxParametersProps = {
  initProcessEnabled: false,
  maxSwap: size,
  sharedMemorySize: size,
  swappiness: 123,
};

Properties ​

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

Default: No swap.

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.

sharedMemorySizeSizeshared_memory_sizeSizesharedMemorySizeSizeSharedMemorySizeSizeSharedMemorySizeSize#
The value for the size of the /dev/shm volume.

Default: No shared memory.

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.