software.amazon.awssdk.services.ecs.model

Interface LinuxParameters.Builder

All Superinterfaces:

Buildable, CopyableBuilder<LinuxParameters.Builder,LinuxParameters>, SdkBuilder<LinuxParameters.Builder,LinuxParameters>, SdkPojo

Enclosing class:

LinuxParameters

public static interface LinuxParameters.Builder
extends SdkPojo, CopyableBuilder<LinuxParameters.Builder,LinuxParameters>

Method Summary

Modifier and Type	Method and Description
default LinuxParameters.Builder	capabilities(Consumer<KernelCapabilities.Builder> capabilities) The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
LinuxParameters.Builder	capabilities(KernelCapabilities capabilities) The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
LinuxParameters.Builder	devices(Collection<Device> devices) Any host devices to expose to the container.
LinuxParameters.Builder	devices(Consumer<Device.Builder>... devices) Any host devices to expose to the container.
LinuxParameters.Builder	devices(Device... devices) Any host devices to expose to the container.
LinuxParameters.Builder	initProcessEnabled(Boolean initProcessEnabled) Run an init process inside the container that forwards signals and reaps processes.
LinuxParameters.Builder	maxSwap(Integer maxSwap) The total amount of swap memory (in MiB) a container can use.
LinuxParameters.Builder	sharedMemorySize(Integer sharedMemorySize) The value for the size (in MiB) of the /dev/shm volume.
LinuxParameters.Builder	swappiness(Integer swappiness) This allows you to tune a container's memory swappiness behavior.
LinuxParameters.Builder	tmpfs(Collection<Tmpfs> tmpfs) The container path, mount options, and size (in MiB) of the tmpfs mount.
LinuxParameters.Builder	tmpfs(Consumer<Tmpfs.Builder>... tmpfs) The container path, mount options, and size (in MiB) of the tmpfs mount.
LinuxParameters.Builder	tmpfs(Tmpfs... tmpfs) The container path, mount options, and size (in MiB) of the tmpfs mount.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

capabilities

LinuxParameters.Builder capabilities(KernelCapabilities 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.

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:

Returns a reference to this object so that method calls can be chained together.

capabilities

default LinuxParameters.Builder capabilities(Consumer<KernelCapabilities.Builder> 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.

This is a convenience method that creates an instance of the KernelCapabilities.Builder avoiding the need to create one manually via KernelCapabilities.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capabilities(KernelCapabilities).

Parameters:

capabilities - a consumer that will call methods on KernelCapabilities.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

capabilities(KernelCapabilities)

devices

LinuxParameters.Builder devices(Collection<Device> devices)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

devices

LinuxParameters.Builder devices(Device... devices)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

devices

LinuxParameters.Builder devices(Consumer<Device.Builder>... devices)

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.

This is a convenience method that creates an instance of the Device.Builder avoiding the need to create one manually via Device.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #devices(List).

Parameters:

devices - a consumer that will call methods on Device.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#devices(java.util.Collection)

initProcessEnabled

LinuxParameters.Builder initProcessEnabled(Boolean 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}}'

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:

Returns a reference to this object so that method calls can be chained together.

sharedMemorySize

LinuxParameters.Builder sharedMemorySize(Integer 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.

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:

Returns a reference to this object so that method calls can be chained together.

tmpfs

LinuxParameters.Builder tmpfs(Collection<Tmpfs> 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.

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:

Returns a reference to this object so that method calls can be chained together.

tmpfs

LinuxParameters.Builder tmpfs(Tmpfs... 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.

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:

Returns a reference to this object so that method calls can be chained together.

tmpfs

LinuxParameters.Builder tmpfs(Consumer<Tmpfs.Builder>... 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.

This is a convenience method that creates an instance of the Tmpfs.Builder avoiding the need to create one manually via Tmpfs.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tmpfs(List).

Parameters:

tmpfs - a consumer that will call methods on Tmpfs.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tmpfs(java.util.Collection)

maxSwap

LinuxParameters.Builder maxSwap(Integer 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.

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:

Returns a reference to this object so that method calls can be chained together.

swappiness

LinuxParameters.Builder swappiness(Integer 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.

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:

Returns a reference to this object so that method calls can be chained together.