software.amazon.awscdk.services.ecs

Interface CfnTaskDefinition.LinuxParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskDefinition.LinuxParametersProperty.Jsii$Proxy

Enclosing class:

CfnTaskDefinition

@Stability(value=Stable)
public static interface CfnTaskDefinition.LinuxParametersProperty
extends software.amazon.jsii.JsiiSerializable

The `LinuxParameters` property specifies Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html) .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 LinuxParametersProperty linuxParametersProperty = LinuxParametersProperty.builder()
         .capabilities(KernelCapabilitiesProperty.builder()
                 .add(List.of("add"))
                 .drop(List.of("drop"))
                 .build())
         .devices(List.of(DeviceProperty.builder()
                 .containerPath("containerPath")
                 .hostPath("hostPath")
                 .permissions(List.of("permissions"))
                 .build()))
         .initProcessEnabled(false)
         .maxSwap(123)
         .sharedMemorySize(123)
         .swappiness(123)
         .tmpfs(List.of(TmpfsProperty.builder()
                 .size(123)
                 // the properties below are optional
                 .containerPath("containerPath")
                 .mountOptions(List.of("mountOptions"))
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnTaskDefinition.LinuxParametersProperty.Builder A builder for CfnTaskDefinition.LinuxParametersProperty
static class	CfnTaskDefinition.LinuxParametersProperty.Jsii$Proxy An implementation for CfnTaskDefinition.LinuxParametersProperty

Method Summary

Modifier and Type	Method and Description
static CfnTaskDefinition.LinuxParametersProperty.Builder	builder()
default Object	getCapabilities() The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
default Object	getDevices() Any host devices to expose to the container.
default Object	getInitProcessEnabled() Run an `init` process inside the container that forwards signals and reaps processes.
default Number	getMaxSwap() The total amount of swap memory (in MiB) a container can use.
default Number	getSharedMemorySize() The value for the size (in MiB) of the `/dev/shm` volume.
default Number	getSwappiness() This allows you to tune a container's memory swappiness behavior.
default Object	getTmpfs() The container path, mount options, and size (in MiB) of the tmpfs mount.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCapabilities

@Stability(value=Stable)
 @Nullable
default Object getCapabilities()

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

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

getDevices

@Stability(value=Stable)
 @Nullable
default Object getDevices()

Any host devices to expose to the container.

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

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

getInitProcessEnabled

@Stability(value=Stable)
 @Nullable
default Object getInitProcessEnabled()

Run an `init` process inside the container that forwards signals and reaps processes.

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}}'

getMaxSwap

@Stability(value=Stable)
 @Nullable
default Number getMaxSwap()

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

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 maxSwap parameter isn't supported.

getSharedMemorySize

@Stability(value=Stable)
 @Nullable
default Number getSharedMemorySize()

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

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

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

getSwappiness

@Stability(value=Stable)
 @Nullable
default Number getSwappiness()

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

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 swappiness parameter isn't supported.

getTmpfs

@Stability(value=Stable)
 @Nullable
default Object getTmpfs()

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

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

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

builder

@Stability(value=Stable)
static CfnTaskDefinition.LinuxParametersProperty.Builder builder()

Returns:

a CfnTaskDefinition.LinuxParametersProperty.Builder of CfnTaskDefinition.LinuxParametersProperty