@Generated(value="software.amazon.awssdk:codegen") public final class LinuxParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LinuxParameters.Builder,LinuxParameters>
Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
Modifier and Type | Class and Description |
---|---|
static interface |
LinuxParameters.Builder |
Modifier and Type | Method and Description |
---|---|
static LinuxParameters.Builder |
builder() |
KernelCapabilities |
capabilities()
The Linux capabilities for the container that are added to or dropped from the default configuration provided by
Docker.
|
List<Device> |
devices()
Any host devices to expose to the container.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasDevices()
Returns true if the Devices property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasTmpfs()
Returns true if the Tmpfs property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
Boolean |
initProcessEnabled()
Run an
init process inside the container that forwards signals and reaps processes. |
Integer |
maxSwap()
The total amount of swap memory (in MiB) a container can use.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends LinuxParameters.Builder> |
serializableBuilderClass() |
Integer |
sharedMemorySize()
The value for the size (in MiB) of the
/dev/shm volume. |
Integer |
swappiness()
This allows you to tune a container's memory swappiness behavior.
|
List<Tmpfs> |
tmpfs()
The container path, mount options, and size (in MiB) of the tmpfs mount.
|
LinuxParameters.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final 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.
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.
public final boolean hasDevices()
public final List<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 are using tasks that use the Fargate launch type, the devices
parameter is not supported.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDevices()
to see if a value was sent in this field.
Devices
in the Create a container section
of the Docker Remote API and the
--device
option to docker run.
If you are using tasks that use the Fargate launch type, the devices
parameter is not
supported.
public final 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}}'
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}}'
public final 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.
/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.
public final boolean hasTmpfs()
public final List<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 are using tasks that use the Fargate launch type, the tmpfs
parameter is not supported.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTmpfs()
to see if a value was sent in this field.
--tmpfs
option to docker run.
If you are using tasks that use the Fargate launch type, the tmpfs
parameter is not
supported.
public final 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 are using tasks that use the Fargate launch type, the maxSwap
parameter is not supported.
--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 are using tasks that use the Fargate launch type, the maxSwap
parameter is not
supported.
public final 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 are using tasks that use the Fargate launch type, the swappiness
parameter is not supported.
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 are using tasks that use the Fargate launch type, the swappiness
parameter is not
supported.
public LinuxParameters.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<LinuxParameters.Builder,LinuxParameters>
public static LinuxParameters.Builder builder()
public static Class<? extends LinuxParameters.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.