Class CfnJobDefinition.LinuxParametersProperty

Linux-specific modifications that are applied to the container, such as details for device mappings.

Inheritance

object

CfnJobDefinition.LinuxParametersProperty

Implements

CfnJobDefinition.ILinuxParametersProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Batch

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnJobDefinition.LinuxParametersProperty : CfnJobDefinition.ILinuxParametersProperty

Syntax (vb)

Public Class CfnJobDefinition.LinuxParametersProperty Implements CfnJobDefinition.ILinuxParametersProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html

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.AWS.Batch;

             var linuxParametersProperty = new LinuxParametersProperty {
                 Devices = new [] { new DeviceProperty {
                     ContainerPath = "containerPath",
                     HostPath = "hostPath",
                     Permissions = new [] { "permissions" }
                 } },
                 InitProcessEnabled = false,
                 MaxSwap = 123,
                 SharedMemorySize = 123,
                 Swappiness = 123,
                 Tmpfs = new [] { new TmpfsProperty {
                     ContainerPath = "containerPath",
                     Size = 123,

                     // the properties below are optional
                     MountOptions = new [] { "mountOptions" }
                 } }
             };

Synopsis

Constructors

LinuxParametersProperty()

Linux-specific modifications that are applied to the container, such as details for device mappings.

Properties

Devices	Any of the host devices to expose to the container.
InitProcessEnabled	If true, run an `init` process inside the container that forwards signals and reaps processes.
MaxSwap	The total amount of swap memory (in MiB) a container can use.
SharedMemorySize	The value for the size (in MiB) of the `/dev/shm` volume.
Swappiness	You can use this parameter to tune a container's memory swappiness behavior.
Tmpfs	The container path, mount options, and size (in MiB) of the `tmpfs` mount.

Constructors

LinuxParametersProperty()

Linux-specific modifications that are applied to the container, such as details for device mappings.

public LinuxParametersProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html

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.AWS.Batch;

             var linuxParametersProperty = new LinuxParametersProperty {
                 Devices = new [] { new DeviceProperty {
                     ContainerPath = "containerPath",
                     HostPath = "hostPath",
                     Permissions = new [] { "permissions" }
                 } },
                 InitProcessEnabled = false,
                 MaxSwap = 123,
                 SharedMemorySize = 123,
                 Swappiness = 123,
                 Tmpfs = new [] { new TmpfsProperty {
                     ContainerPath = "containerPath",
                     Size = 123,

                     // the properties below are optional
                     MountOptions = new [] { "mountOptions" }
                 } }
             };

Properties

Devices

Any of the host devices to expose to the container.

public object? Devices { get; set; }

Property Value

object

Remarks

This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-devices

Type union: either IResolvable or (either IResolvable or CfnJobDefinition.IDeviceProperty)[]

InitProcessEnabled

If true, run an init process inside the container that forwards signals and reaps processes.

public object? InitProcessEnabled { get; set; }

Property Value

object

Remarks

This parameter maps to the --init option to docker run . This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-initprocessenabled

Type union: either bool or IResolvable

MaxSwap

The total amount of swap memory (in MiB) a container can use.

public double? MaxSwap { get; set; }

Property Value

double?

Remarks

This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance on which it runs. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-maxswap

SharedMemorySize

The value for the size (in MiB) of the /dev/shm volume.

public double? SharedMemorySize { get; set; }

Property Value

double?

Remarks

This parameter maps to the --shm-size option to docker run .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-sharedmemorysize

Swappiness

You can use this parameter to tune a container's memory swappiness behavior.

public double? Swappiness { get; set; }

Property Value

double?

Remarks

A swappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100 . If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap , then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run .

Consider the following when you use a per-container swap configuration.

By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html">Instance store swap volumes</a> in the <em>Amazon EC2 User Guide for Linux Instances</em> or <a href="https://docs.aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/">How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?</a>

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-swappiness

Tmpfs

The container path, mount options, and size (in MiB) of the tmpfs mount.

public object? Tmpfs { get; set; }

Property Value

object

Remarks

This parameter maps to the --tmpfs option to docker run .

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-linuxparameters.html#cfn-batch-jobdefinition-linuxparameters-tmpfs

Type union: either IResolvable or (either IResolvable or CfnJobDefinition.ITmpfsProperty)[]

Implements

CfnJobDefinition.ILinuxParametersProperty