Interface ILinuxParametersProps

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

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ILinuxParametersProps

Syntax (vb)

Public Interface ILinuxParametersProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;
            using Amazon.CDK.AWS.Batch;

            Size size;

            var linuxParametersProps = new LinuxParametersProps {
                InitProcessEnabled = false,
                MaxSwap = size,
                SharedMemorySize = size,
                Swappiness = 123
            };

Synopsis

Properties

InitProcessEnabled	Specifies whether to run an init process inside the container that forwards signals and reaps processes.
MaxSwap	The total amount of swap memory a container can use.
SharedMemorySize	The value for the size of the /dev/shm volume.
Swappiness	This allows you to tune a container's memory swappiness behavior.

Properties

InitProcessEnabled

Specifies whether to run an init process inside the container that forwards signals and reaps processes.

bool? InitProcessEnabled { get; }

Property Value

bool?

Remarks

Default: false

MaxSwap

The total amount of swap memory a container can use.

Size? MaxSwap { get; }

Property Value

Size

Remarks

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.

Default: No swap.

SharedMemorySize

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

Size? SharedMemorySize { get; }

Property Value

Size

Remarks

Default: No shared memory.

Swappiness

This allows you to tune a container's memory swappiness behavior.

double? Swappiness { get; }

Property Value

double?

Remarks

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.

Default: 60