java.lang.Object
- software.amazon.awssdk.services.batch.model.LinuxParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LinuxParameters.Builder,LinuxParameters>
```
@Generated("software.amazon.awssdk:codegen")
public final class LinuxParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LinuxParameters.Builder,LinuxParameters>
```
Linux-specific modifications that are applied to the container, such as details for device mappings.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface LinuxParameters.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static LinuxParameters.Builder`	`builder()`
`List<Device>`	`devices()`	Any of the host devices to expose to the container.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDevices()`	For responses, this returns true if the service returned a value for the Devices property.
`int`	`hashCode()`
`boolean`	`hasTmpfs()`	For responses, this returns true if the service returned a value for the Tmpfs property.
`Boolean`	`initProcessEnabled()`	If true, 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()`	You can use this parameter 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()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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 the isEmpty() 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
```
public final List<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.
    
    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 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.
  - initProcessEnabled
```
public final 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"
    
    Returns:
    
    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"
  - sharedMemorySize
```
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.
    
    This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
    
    Returns:
    
    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.
  - 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 the isEmpty() 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
```
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.
    
    This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
    
    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.
    
    This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
  - maxSwap
```
public final 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.
    
    Returns:
    
    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.
  - swappiness
```
public final 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.
    Returns:
    
    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.
  - toBuilder
```
public LinuxParameters.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LinuxParameters.Builder,LinuxParameters>
  - builder
```
public static LinuxParameters.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends LinuxParameters.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class LinuxParameters

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasDevices

devices

initProcessEnabled

sharedMemorySize

hasTmpfs

tmpfs

maxSwap

swappiness

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields