software.amazon.awssdk.services.batch.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
LinuxParameters.Builder	devices(Collection<Device> devices) Any of the host devices to expose to the container.
LinuxParameters.Builder	devices(Consumer<Device.Builder>... devices) Any of the host devices to expose to the container.
LinuxParameters.Builder	devices(Device... devices) Any of the host devices to expose to the container.
LinuxParameters.Builder	initProcessEnabled(Boolean initProcessEnabled) If true, 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) You can use this parameter 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

devices

LinuxParameters.Builder devices(Collection<Device> devices)

Any of the 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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Parameters:

devices - Any of the 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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Returns:

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

devices

LinuxParameters.Builder devices(Device... devices)

Any of the 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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Parameters:

devices - Any of the 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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Returns:

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

devices

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

Any of the 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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

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)

If true, 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 | grep "Server API version"

Parameters:

initProcessEnabled - If true, 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 | grep "Server API version"

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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

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 is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Parameters:

maxSwap - The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Returns:

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

swappiness

LinuxParameters.Builder swappiness(Integer swappiness)

You can use this parameter to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap configuration.

• Swap space must be enabled and allocated on the container instance for the containers to use.

  By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

• The swap space parameters are only supported for job definitions using EC2 resources.

• If the maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Parameters:

swappiness - You can use this parameter to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap configuration.

• Swap space must be enabled and allocated on the container instance for the containers to use.

  By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

• The swap space parameters are only supported for job definitions using EC2 resources.

• If the maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Returns:

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