Class CfnTaskDefinitionPropsMixin.LinuxParametersProperty

The Linux-specific options that are applied to the container, such as Linux KernelCapabilities .

Inheritance

object

CfnTaskDefinitionPropsMixin.LinuxParametersProperty

Implements

CfnTaskDefinitionPropsMixin.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.Mixins.Preview.AWS.ECS.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnTaskDefinitionPropsMixin.LinuxParametersProperty : CfnTaskDefinitionPropsMixin.ILinuxParametersProperty

Syntax (vb)

Public Class CfnTaskDefinitionPropsMixin.LinuxParametersProperty Implements CfnTaskDefinitionPropsMixin.ILinuxParametersProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-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.Mixins.Preview.AWS.ECS.Mixins;

             var linuxParametersProperty = new LinuxParametersProperty {
                 Capabilities = new KernelCapabilitiesProperty {
                     Add = new [] { "add" },
                     Drop = new [] { "drop" }
                 },
                 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",
                     MountOptions = new [] { "mountOptions" },
                     Size = 123
                 } }
             };

Synopsis

Constructors

LinuxParametersProperty()

The Linux-specific options that are applied to the container, such as Linux KernelCapabilities .

Properties

Capabilities	The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
Devices	Any host devices to expose to the container.
InitProcessEnabled	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	This allows you to tune a container's memory swappiness behavior.
Tmpfs	The container path, mount options, and size (in MiB) of the tmpfs mount.

Constructors

LinuxParametersProperty()

The Linux-specific options that are applied to the container, such as Linux KernelCapabilities .

public LinuxParametersProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-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.Mixins.Preview.AWS.ECS.Mixins;

             var linuxParametersProperty = new LinuxParametersProperty {
                 Capabilities = new KernelCapabilitiesProperty {
                     Add = new [] { "add" },
                     Drop = new [] { "drop" }
                 },
                 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",
                     MountOptions = new [] { "mountOptions" },
                     Size = 123
                 } }
             };

Properties

Capabilities

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

public object? Capabilities { get; set; }

Property Value

object

Remarks

For tasks that use the Fargate launch type, <code>capabilities</code> is supported for all platform versions but the <code>add</code> parameter is only supported if using platform version 1.4.0 or later.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-linuxparameters-capabilities

Type union: either IResolvable or CfnTaskDefinitionPropsMixin.IKernelCapabilitiesProperty

Devices

Any host devices to expose to the container.

public object? Devices { get; set; }

Property Value

object

Remarks

This parameter maps to Devices in the docker container create command and the --device option to docker run.

If you're using tasks that use the Fargate launch type, the <code>devices</code> parameter isn't supported.

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

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

InitProcessEnabled

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 --format '{{.Server.APIVersion}}'

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-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 will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.

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

If you're using tasks that use the Fargate launch type, the <code>maxSwap</code> parameter isn't supported.

If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't supported.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-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.

If you are using tasks that use the Fargate launch type, the <code>sharedMemorySize</code> parameter is not supported.

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

Swappiness

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

public double? Swappiness { get; set; }

Property Value

double?

Remarks

A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100 . If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.

If you're using tasks that use the Fargate launch type, the <code>swappiness</code> parameter isn't supported.

If you're using tasks on Amazon Linux 2023 the swappiness parameter isn't supported.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-linuxparameters.html#cfn-ecs-taskdefinition-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.

If you're using tasks that use the Fargate launch type, the <code>tmpfs</code> parameter isn't supported.

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

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

Implements

CfnTaskDefinitionPropsMixin.ILinuxParametersProperty