Package software.amazon.awscdk.services.ecs

Interface CfnDaemonTaskDefinition.LinuxParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDaemonTaskDefinition.LinuxParametersProperty.Jsii$Proxy

Enclosing class:

CfnDaemonTaskDefinition

@Stability(Stable)
public static interface CfnDaemonTaskDefinition.LinuxParametersProperty
extends software.amazon.jsii.JsiiSerializable

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 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)
         .tmpfs(List.of(TmpfsProperty.builder()
                 .size(123)
                 // the properties below are optional
                 .containerPath("containerPath")
                 .mountOptions(List.of("mountOptions"))
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-daemontaskdefinition-linuxparameters.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDaemonTaskDefinition.LinuxParametersProperty.Builder	builder()
default Object	getCapabilities()	The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition.
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 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 Details

getCapabilities

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

The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition.

For more detailed information about these Linux capabilities, see the capabilities(7) Linux manual page. The following describes how Docker processes the Linux capabilities specified in the add and drop request parameters. For information about the latest behavior, see Docker Compose: order of cap_drop and cap_add in the Docker Community Forum.

• When the container is a privleged container, the container capabilities are all of the default Docker capabilities. The capabilities specified in the add request parameter, and the drop request parameter are ignored.
• When the add request parameter is set to ALL, the container capabilities are all of the default Docker capabilities, excluding those specified in the drop request parameter.
• When the drop request parameter is set to ALL, the container capabilities are the capabilities specified in the add request parameter.
• When the add request parameter and the drop request parameter are both empty, the capabilities the container capabilities are all of the default Docker capabilities.
• The default is to first drop the capabilities specified in the drop request parameter, and then add the capabilities specified in the add request parameter.

Returns union: either IResolvable or CfnDaemonTaskDefinition.KernelCapabilitiesProperty

See Also:

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

getDevices

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

Any host devices to expose to the container.

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDaemonTaskDefinition.DeviceProperty>

See Also:

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

getInitProcessEnabled

@Stability(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}}'

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-daemontaskdefinition-linuxparameters.html#cfn-ecs-daemontaskdefinition-linuxparameters-initprocessenabled

getTmpfs

@Stability(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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDaemonTaskDefinition.TmpfsProperty>

See Also:

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

builder

@Stability(Stable)
static CfnDaemonTaskDefinition.LinuxParametersProperty.Builder builder()

Returns:

a CfnDaemonTaskDefinition.LinuxParametersProperty.Builder of CfnDaemonTaskDefinition.LinuxParametersProperty