class LinuxParameters (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Batch.LinuxParameters |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#LinuxParameters |
![]() | software.amazon.awscdk.services.batch.LinuxParameters |
![]() | aws_cdk.aws_batch.LinuxParameters |
![]() | aws-cdk-lib » aws_batch » LinuxParameters |
Implements
IConstruct
, IDependable
Linux-specific options that are applied to the container.
Example
// 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 linuxParameters = new batch.LinuxParameters(this, 'MyLinuxParameters', /* all optional props */ {
initProcessEnabled: false,
maxSwap: size,
sharedMemorySize: size,
swappiness: 123,
});
Initializer
new LinuxParameters(scope: Construct, id: string, props?: LinuxParametersProps)
Parameters
- scope
Construct
- id
string
- props
Linux
Parameters Props
Constructs a new instance of the LinuxParameters class.
Construct Props
Name | Type | Description |
---|---|---|
init | boolean | Specifies whether to run an init process inside the container that forwards signals and reaps processes. |
max | Size | The total amount of swap memory a container can use. |
shared | Size | The value for the size of the /dev/shm volume. |
swappiness? | number | This allows you to tune a container's memory swappiness behavior. |
initProcessEnabled?
Type:
boolean
(optional, default: false)
Specifies whether to run an init process inside the container that forwards signals and reaps processes.
maxSwap?
Type:
Size
(optional, default: 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.
sharedMemorySize?
Type:
Size
(optional, default: No shared memory.)
The value for the size of the /dev/shm volume.
swappiness?
Type:
number
(optional, default: 60)
This allows you to tune a container's memory swappiness behavior.
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.
Properties
Name | Type | Description |
---|---|---|
devices | Device [] | Device mounts. |
node | Node | The tree node. |
tmpfs | Tmpfs [] | TmpFs mounts. |
init | boolean | Whether the init process is enabled. |
max | Size | The max swap memory. |
shared | Size | The shared memory size (in MiB). |
swappiness? | number | The swappiness behavior. |
devices
Type:
Device
[]
Device mounts.
node
Type:
Node
The tree node.
tmpfs
Type:
Tmpfs
[]
TmpFs mounts.
initProcessEnabled?
Type:
boolean
(optional)
Whether the init process is enabled.
maxSwap?
Type:
Size
(optional)
The max swap memory.
sharedMemorySize?
Type:
Size
(optional)
The shared memory size (in MiB).
Not valid for Fargate launch type
swappiness?
Type:
number
(optional)
The swappiness behavior.
Methods
Name | Description |
---|---|
add | Adds one or more host devices to a container. |
add | Specifies the container path, mount options, and size (in MiB) of the tmpfs mount for a container. |
render | Renders the Linux parameters to the Batch version of this resource, which does not have 'capabilities' and requires tmpfs.containerPath to be defined. |
to | Returns a string representation of this construct. |
addDevices(...device)
public addDevices(...device: Device[]): void
Parameters
- device
Device
Adds one or more host devices to a container.
addTmpfs(...tmpfs)
public addTmpfs(...tmpfs: Tmpfs[]): void
Parameters
- tmpfs
Tmpfs
Specifies the container path, mount options, and size (in MiB) of the tmpfs mount for a container.
Only works with EC2 launch type.
renderLinuxParameters()
public renderLinuxParameters(): LinuxParametersProperty
Returns
Renders the Linux parameters to the Batch version of this resource, which does not have 'capabilities' and requires tmpfs.containerPath to be defined.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.