Class LinuxParameters

Linux-specific options that are applied to the container.

Inheritance

object

LinuxParameters

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class LinuxParameters : Construct

Syntax (vb)

Public Class LinuxParameters Inherits Construct

Remarks

ExampleMetadata: infused

Examples

TaskDefinition taskDefinition;


            taskDefinition.AddContainer("container", new ContainerDefinitionOptions {
                Image = ContainerImage.FromRegistry("amazon/amazon-ecs-sample"),
                MemoryLimitMiB = 1024,
                LinuxParameters = new LinuxParameters(this, "LinuxParameters", new LinuxParametersProps {
                    InitProcessEnabled = true,
                    SharedMemorySize = 1024,
                    MaxSwap = Size.Mebibytes(5000),
                    Swappiness = 90
                })
            });

Synopsis

Constructors

LinuxParameters(Construct, string, ILinuxParametersProps?)

Constructs a new instance of the LinuxParameters class.

Methods

AddCapabilities(params Capability[])	Adds one or more Linux capabilities to the Docker configuration of a container.
AddDevices(params IDevice[])	Adds one or more host devices to a container.
AddTmpfs(params ITmpfs[])	Specifies the container path, mount options, and size (in MiB) of the tmpfs mount for a container.
DropCapabilities(params Capability[])	Removes one or more Linux capabilities to the Docker configuration of a container.
RenderLinuxParameters()	Renders the Linux parameters to a CloudFormation object.

Constructors

LinuxParameters(Construct, string, ILinuxParametersProps?)

Constructs a new instance of the LinuxParameters class.

public LinuxParameters(Construct scope, string id, ILinuxParametersProps? props = null)

Parameters

scope Construct

id string

props ILinuxParametersProps

Remarks

ExampleMetadata: infused

Methods

AddCapabilities(params Capability[])

Adds one or more Linux capabilities to the Docker configuration of a container.

public virtual void AddCapabilities(params Capability[] cap)

Parameters

cap Capability[]

Remarks

Tasks launched on Fargate only support adding the 'SYS_PTRACE' kernel capability.

AddDevices(params IDevice[])

Adds one or more host devices to a container.

public virtual void AddDevices(params IDevice[] device)

Parameters

device IDevice[]

Remarks

ExampleMetadata: infused

AddTmpfs(params ITmpfs[])

Specifies the container path, mount options, and size (in MiB) of the tmpfs mount for a container.

public virtual void AddTmpfs(params ITmpfs[] tmpfs)

Parameters

tmpfs ITmpfs[]

Remarks

Only works with EC2 launch type.

DropCapabilities(params Capability[])

Removes one or more Linux capabilities to the Docker configuration of a container.

public virtual void DropCapabilities(params Capability[] cap)

Parameters

cap Capability[]

Remarks

ExampleMetadata: infused

RenderLinuxParameters()

Renders the Linux parameters to a CloudFormation object.

public virtual CfnTaskDefinition.ILinuxParametersProperty RenderLinuxParameters()

Returns

CfnTaskDefinition.ILinuxParametersProperty

Remarks

ExampleMetadata: infused