LinuxParametersProperty Struct
The Linux-specific options that are applied to the container, such as Linux KernelCapabilities .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const linuxParametersProperty: ecs.CfnTaskDefinition.LinuxParametersProperty = {
capabilities: {
add: ['add'],
drop: ['drop'],
},
devices: [{
containerPath: 'containerPath',
hostPath: 'hostPath',
permissions: ['permissions'],
}],
initProcessEnabled: false,
maxSwap: 123,
sharedMemorySize: 123,
swappiness: 123,
tmpfs: [{
size: 123,
// the properties below are optional
containerPath: 'containerPath',
mountOptions: ['mountOptions'],
}],
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ecs as ecs
linux_parameters_property = ecs.CfnTaskDefinition.LinuxParametersProperty(
capabilities=ecs.CfnTaskDefinition.KernelCapabilitiesProperty(
add=["add"],
drop=["drop"]
),
devices=[ecs.CfnTaskDefinition.DeviceProperty(
container_path="containerPath",
host_path="hostPath",
permissions=["permissions"]
)],
init_process_enabled=False,
max_swap=123,
shared_memory_size=123,
swappiness=123,
tmpfs=[ecs.CfnTaskDefinition.TmpfsProperty(
size=123,
# the properties below are optional
container_path="containerPath",
mount_options=["mountOptions"]
)]
)
// 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();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;
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 {
Size = 123,
// the properties below are optional
ContainerPath = "containerPath",
MountOptions = new [] { "mountOptions" }
} }
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
linuxParametersProperty := &LinuxParametersProperty{
Capabilities: &KernelCapabilitiesProperty{
Add: []*string{
jsii.String("add"),
},
Drop: []*string{
jsii.String("drop"),
},
},
Devices: []interface{}{
&DeviceProperty{
ContainerPath: jsii.String("containerPath"),
HostPath: jsii.String("hostPath"),
Permissions: []*string{
jsii.String("permissions"),
},
},
},
InitProcessEnabled: jsii.Boolean(false),
MaxSwap: jsii.Number(123),
SharedMemorySize: jsii.Number(123),
Swappiness: jsii.Number(123),
Tmpfs: []interface{}{
&TmpfsProperty{
Size: jsii.Number(123),
// the properties below are optional
ContainerPath: jsii.String("containerPath"),
MountOptions: []*string{
jsii.String("mountOptions"),
},
},
},
}
Properties
capabilitiesoptionalIResolvable | CfnTaskDefinition.KernelCapabilitiesPropertycapabilitiesoptionaltyping.Union[IResolvable, KernelCapabilitiesProperty]capabilitiesoptionalIResolvableCapabilitiesoptionalIResolvableCapabilitiesoptionalinterface{}#For tasks that use the Fargate launch type,
capabilitiesis supported for all platform versions but theaddparameter is only supported if using platform version 1.4.0 or later.
devicesoptionalIResolvable | IResolvable | CfnTaskDefinition.DeviceProperty[]devicesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DeviceProperty]]]devicesoptionalIResolvableDevicesoptionalIResolvableDevicesoptionalinterface{}#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
devicesparameter isn't supported.
initProcessEnabledoptionalboolean | IResolvableinit_process_enabledoptionaltyping.Union[bool, IResolvable]initProcessEnabledoptionalBooleanInitProcessEnabledoptionalboolInitProcessEnabledoptionalinterface{}#notes
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}}'
maxSwapoptionalnumbermax_swapoptionalint | floatmaxSwapoptionalNumberMaxSwapoptionaldoubleMaxSwapoptional*float64#notes
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
maxSwapparameter isn't supported.If you're using tasks on Amazon Linux 2023 the
swappinessparameter isn't supported.
swappinessoptionalnumberswappinessoptionalint | floatswappinessoptionalNumberSwappinessoptionaldoubleSwappinessoptional*float64#notes
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
swappinessparameter isn't supported.If you're using tasks on Amazon Linux 2023 the
swappinessparameter isn't supported.
tmpfsoptionalIResolvable | IResolvable | CfnTaskDefinition.TmpfsProperty[]tmpfsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TmpfsProperty]]]tmpfsoptionalIResolvableTmpfsoptionalIResolvableTmpfsoptionalinterface{}#This parameter maps to the --tmpfs option to docker run.
If you're using tasks that use the Fargate launch type, the
tmpfsparameter isn't supported.