Package software.amazon.awscdk.services.ecs

Class CfnTaskDefinition.LinuxParametersProperty.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.CfnTaskDefinition.LinuxParametersProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTaskDefinition.LinuxParametersProperty>

Enclosing interface:

CfnTaskDefinition.LinuxParametersProperty

@Stability(Stable)
public static final class CfnTaskDefinition.LinuxParametersProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTaskDefinition.LinuxParametersProperty>

A builder for CfnTaskDefinition.LinuxParametersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnTaskDefinition.LinuxParametersProperty	build()	Builds the configured instance.
CfnTaskDefinition.LinuxParametersProperty.Builder	capabilities(IResolvable capabilities)	Sets the value of CfnTaskDefinition.LinuxParametersProperty.getCapabilities()
CfnTaskDefinition.LinuxParametersProperty.Builder	capabilities(CfnTaskDefinition.KernelCapabilitiesProperty capabilities)	Sets the value of CfnTaskDefinition.LinuxParametersProperty.getCapabilities()
CfnTaskDefinition.LinuxParametersProperty.Builder	devices(List<? extends Object> devices)	Sets the value of CfnTaskDefinition.LinuxParametersProperty.getDevices()
CfnTaskDefinition.LinuxParametersProperty.Builder	devices(IResolvable devices)	Sets the value of CfnTaskDefinition.LinuxParametersProperty.getDevices()
CfnTaskDefinition.LinuxParametersProperty.Builder	initProcessEnabled(Boolean initProcessEnabled)	Sets the value of CfnTaskDefinition.LinuxParametersProperty.getInitProcessEnabled()
CfnTaskDefinition.LinuxParametersProperty.Builder	initProcessEnabled(IResolvable initProcessEnabled)	Sets the value of CfnTaskDefinition.LinuxParametersProperty.getInitProcessEnabled()
CfnTaskDefinition.LinuxParametersProperty.Builder	maxSwap(Number maxSwap)	Sets the value of CfnTaskDefinition.LinuxParametersProperty.getMaxSwap()
CfnTaskDefinition.LinuxParametersProperty.Builder	sharedMemorySize(Number sharedMemorySize)	Sets the value of CfnTaskDefinition.LinuxParametersProperty.getSharedMemorySize()
CfnTaskDefinition.LinuxParametersProperty.Builder	swappiness(Number swappiness)	Sets the value of CfnTaskDefinition.LinuxParametersProperty.getSwappiness()
CfnTaskDefinition.LinuxParametersProperty.Builder	tmpfs(List<? extends Object> tmpfs)	Sets the value of CfnTaskDefinition.LinuxParametersProperty.getTmpfs()
CfnTaskDefinition.LinuxParametersProperty.Builder	tmpfs(IResolvable tmpfs)	Sets the value of CfnTaskDefinition.LinuxParametersProperty.getTmpfs()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

capabilities

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty.Builder capabilities(IResolvable capabilities)

Sets the value of CfnTaskDefinition.LinuxParametersProperty.getCapabilities()

Parameters:

capabilities - 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.

Returns:

this

capabilities

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty.Builder capabilities(CfnTaskDefinition.KernelCapabilitiesProperty capabilities)

Sets the value of CfnTaskDefinition.LinuxParametersProperty.getCapabilities()

Parameters:

capabilities - 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.

Returns:

this

devices

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty.Builder devices(IResolvable devices)

Sets the value of CfnTaskDefinition.LinuxParametersProperty.getDevices()

Parameters:

devices - 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:

this

devices

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty.Builder devices(List<? extends Object> devices)

Sets the value of CfnTaskDefinition.LinuxParametersProperty.getDevices()

Parameters:

devices - 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:

this

initProcessEnabled

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty.Builder initProcessEnabled(Boolean initProcessEnabled)

Sets the value of CfnTaskDefinition.LinuxParametersProperty.getInitProcessEnabled()

Parameters:

initProcessEnabled - 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:

this

initProcessEnabled

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty.Builder initProcessEnabled(IResolvable initProcessEnabled)

Sets the value of CfnTaskDefinition.LinuxParametersProperty.getInitProcessEnabled()

Parameters:

initProcessEnabled - 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:

this

maxSwap

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty.Builder maxSwap(Number maxSwap)

Sets the value of CfnTaskDefinition.LinuxParametersProperty.getMaxSwap()

Parameters:

maxSwap - 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.

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

Returns:

this

sharedMemorySize

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty.Builder sharedMemorySize(Number sharedMemorySize)

Sets the value of CfnTaskDefinition.LinuxParametersProperty.getSharedMemorySize()

Parameters:

sharedMemorySize - 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.

Returns:

this

swappiness

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty.Builder swappiness(Number swappiness)

Sets the value of CfnTaskDefinition.LinuxParametersProperty.getSwappiness()

Parameters:

swappiness - 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.

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

Returns:

this

tmpfs

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty.Builder tmpfs(IResolvable tmpfs)

Sets the value of CfnTaskDefinition.LinuxParametersProperty.getTmpfs()

Parameters:

tmpfs - 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:

this

tmpfs

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty.Builder tmpfs(List<? extends Object> tmpfs)

Sets the value of CfnTaskDefinition.LinuxParametersProperty.getTmpfs()

Parameters:

tmpfs - 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:

this

build

@Stability(Stable)
public CfnTaskDefinition.LinuxParametersProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnTaskDefinition.LinuxParametersProperty>

Returns:

a new instance of CfnTaskDefinition.LinuxParametersProperty

Throws:

NullPointerException - if any required attribute was not provided