Class LinuxParameters
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<LinuxParameters.Builder,
LinuxParameters>
The Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic LinuxParameters.Builder
builder()
final KernelCapabilities
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.devices()
Any host devices to expose to the container.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Devices property.final int
hashCode()
final boolean
hasTmpfs()
For responses, this returns true if the service returned a value for the Tmpfs property.final Boolean
Run aninit
process inside the container that forwards signals and reaps processes.final Integer
maxSwap()
The total amount of swap memory (in MiB) a container can use.static Class
<? extends LinuxParameters.Builder> final Integer
The value for the size (in MiB) of the/dev/shm
volume.final Integer
This allows you to tune a container's memory swappiness behavior.tmpfs()
The container path, mount options, and size (in MiB) of the tmpfs mount.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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.- Returns:
- 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.
-
hasDevices
public final boolean hasDevices()For responses, this returns true if the service returned a value for the Devices property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDevices()
method.- Returns:
- 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.
-
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:
- 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}}'
-
hasTmpfs
public final boolean hasTmpfs()For responses, this returns true if the service returned a value for the Tmpfs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTmpfs()
method.- Returns:
- 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.
-
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:
- 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.
-
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.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<LinuxParameters.Builder,
LinuxParameters> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-