Interface LinuxParameters.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<LinuxParameters.Builder,
,LinuxParameters> SdkBuilder<LinuxParameters.Builder,
,LinuxParameters> SdkPojo
- Enclosing class:
LinuxParameters
-
Method Summary
Modifier and TypeMethodDescriptiondefault 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.capabilities
(KernelCapabilities capabilities) The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.devices
(Collection<Device> devices) Any host devices to expose to the container.devices
(Consumer<Device.Builder>... devices) Any host devices to expose to the container.Any host devices to expose to the container.initProcessEnabled
(Boolean initProcessEnabled) Run aninit
process inside the container that forwards signals and reaps processes.The total amount of swap memory (in MiB) a container can use.sharedMemorySize
(Integer sharedMemorySize) The value for the size (in MiB) of the/dev/shm
volume.swappiness
(Integer swappiness) This allows you to tune a container's memory swappiness behavior.tmpfs
(Collection<Tmpfs> tmpfs) The container path, mount options, and size (in MiB) of the tmpfs mount.tmpfs
(Consumer<Tmpfs.Builder>... tmpfs) The container path, mount options, and size (in MiB) of the tmpfs mount.The container path, mount options, and size (in MiB) of the tmpfs mount.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 theadd
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 theadd
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
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 theadd
parameter is only supported if using platform version 1.4.0 or later.KernelCapabilities.Builder
avoiding the need to create one manually viaKernelCapabilities.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocapabilities(KernelCapabilities)
.- Parameters:
capabilities
- a consumer that will call methods onKernelCapabilities.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 toDevices
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
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 toDevices
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
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.Device.Builder
avoiding the need to create one manually viaDevice.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todevices(List<Device>)
.- Parameters:
devices
- a consumer that will call methods onDevice.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 aninit
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.
-
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
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
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.Tmpfs.Builder
avoiding the need to create one manually viaTmpfs.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totmpfs(List<Tmpfs>)
.- Parameters:
tmpfs
- a consumer that will call methods onTmpfs.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 themaxSwap
value.If a
maxSwap
value of0
is specified, the container will not use swap. Accepted values are0
or any positive integer. If themaxSwap
parameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwap
value must be set for theswappiness
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 themaxSwap
value.If a
maxSwap
value of0
is specified, the container will not use swap. Accepted values are0
or any positive integer. If themaxSwap
parameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwap
value must be set for theswappiness
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
This allows you to tune a container's memory swappiness behavior. A
swappiness
value of0
will cause swapping to not happen unless absolutely necessary. Aswappiness
value of100
will cause pages to be swapped very aggressively. Accepted values are whole numbers between0
and100
. If theswappiness
parameter is not specified, a default value of60
is used. If a value is not specified formaxSwap
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. Aswappiness
value of0
will cause swapping to not happen unless absolutely necessary. Aswappiness
value of100
will cause pages to be swapped very aggressively. Accepted values are whole numbers between0
and100
. If theswappiness
parameter is not specified, a default value of60
is used. If a value is not specified formaxSwap
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.
-