Skip to content
v2.277.0

LinuxParametersProps Struct ​

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

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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_batch as batch

# size: cdk.Size

linux_parameters_props = batch.LinuxParametersProps(
    init_process_enabled=False,
    max_swap=size,
    shared_memory_size=size,
    swappiness=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.batch.*;

Size size;

LinuxParametersProps linuxParametersProps = LinuxParametersProps.builder()
        .initProcessEnabled(false)
        .maxSwap(size)
        .sharedMemorySize(size)
        .swappiness(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var size Size

linuxParametersProps := &LinuxParametersProps{
	InitProcessEnabled: jsii.Boolean(false),
	MaxSwap: size,
	SharedMemorySize: size,
	Swappiness: jsii.Number(123),
}

Properties ​

initProcessEnabledoptionalbooleaninit_process_enabledoptionalboolinitProcessEnabledoptionalBooleanInitProcessEnabledoptionalboolInitProcessEnabledoptional*bool= false#
Specifies whether to run an init process inside the container that forwards signals and reaps processes.
maxSwapoptionalSizemax_swapoptionalSizemaxSwapoptionalSizeMaxSwapoptionalSizeMaxSwapoptionalSize#
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.

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

Default: No shared memory.

swappinessoptionalnumberswappinessoptionalint | floatswappinessoptionalNumberSwappinessoptionaldoubleSwappinessoptional*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.