LinuxParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.batch.model.LinuxParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class LinuxParameters
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Linux-specific modifications that are applied to the container, such as details for device mappings.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

LinuxParameters()

Constructors
Constructor and Description
`LinuxParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LinuxParameters`	`clone()`
`boolean`	`equals(Object obj)`
`List<Device>`	`getDevices()` Any host devices to expose to the container.
`Boolean`	`getInitProcessEnabled()` If true, run an `init` process inside the container that forwards signals and reaps processes.
`Integer`	`getMaxSwap()` The total amount of swap memory (in MiB) a container can use.
`Integer`	`getSharedMemorySize()` The value for the size (in MiB) of the `/dev/shm` volume.
`Integer`	`getSwappiness()` This allows you to tune a container's memory swappiness behavior.
`List<Tmpfs>`	`getTmpfs()` The container path, mount options, and size (in MiB) of the tmpfs mount.
`int`	`hashCode()`
`Boolean`	`isInitProcessEnabled()` If true, run an `init` process inside the container that forwards signals and reaps processes.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDevices(Collection<Device> devices)` Any host devices to expose to the container.
`void`	`setInitProcessEnabled(Boolean initProcessEnabled)` If true, run an `init` process inside the container that forwards signals and reaps processes.
`void`	`setMaxSwap(Integer maxSwap)` The total amount of swap memory (in MiB) a container can use.
`void`	`setSharedMemorySize(Integer sharedMemorySize)` The value for the size (in MiB) of the `/dev/shm` volume.
`void`	`setSwappiness(Integer swappiness)` This allows you to tune a container's memory swappiness behavior.
`void`	`setTmpfs(Collection<Tmpfs> tmpfs)` The container path, mount options, and size (in MiB) of the tmpfs mount.
`String`	`toString()` Returns a string representation of this object.
`LinuxParameters`	`withDevices(Collection<Device> devices)` Any host devices to expose to the container.
`LinuxParameters`	`withDevices(Device... devices)` Any host devices to expose to the container.
`LinuxParameters`	`withInitProcessEnabled(Boolean initProcessEnabled)` If true, run an `init` process inside the container that forwards signals and reaps processes.
`LinuxParameters`	`withMaxSwap(Integer maxSwap)` The total amount of swap memory (in MiB) a container can use.
`LinuxParameters`	`withSharedMemorySize(Integer sharedMemorySize)` The value for the size (in MiB) of the `/dev/shm` volume.
`LinuxParameters`	`withSwappiness(Integer swappiness)` This allows you to tune a container's memory swappiness behavior.
`LinuxParameters`	`withTmpfs(Collection<Tmpfs> tmpfs)` The container path, mount options, and size (in MiB) of the tmpfs mount.
`LinuxParameters`	`withTmpfs(Tmpfs... tmpfs)` The container path, mount options, and size (in MiB) of the tmpfs mount.

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

- Constructor Detail
  - LinuxParameters
```
public LinuxParameters()
```
- Method Detail
  - getDevices
```
public List<Device> getDevices()
```
    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.
    
    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.
  - setDevices
```
public void setDevices(Collection<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.
    
    Parameters:
    
    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.
  - withDevices
```
public LinuxParameters withDevices(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setDevices(java.util.Collection) or withDevices(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDevices
```
public LinuxParameters withDevices(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInitProcessEnabled
```
public void setInitProcessEnabled(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 into 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 into your container instance and run the following command: sudo docker version | grep "Server API version"
  - getInitProcessEnabled
```
public Boolean getInitProcessEnabled()
```
    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 into 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 into your container instance and run the following command: sudo docker version | grep "Server API version"
  - withInitProcessEnabled
```
public LinuxParameters withInitProcessEnabled(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 into 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 into 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.
  - isInitProcessEnabled
```
public Boolean isInitProcessEnabled()
```
    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 into 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 into your container instance and run the following command: sudo docker version | grep "Server API version"
  - setSharedMemorySize
```
public void setSharedMemorySize(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.
    
    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.
  - getSharedMemorySize
```
public Integer getSharedMemorySize()
```
    The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
    
    Returns:
    
    The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.
  - withSharedMemorySize
```
public LinuxParameters withSharedMemorySize(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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTmpfs
```
public List<Tmpfs> getTmpfs()
```
    The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
    
    Returns:
    
    The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.
  - setTmpfs
```
public void setTmpfs(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.
    
    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.
  - withTmpfs
```
public LinuxParameters withTmpfs(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTmpfs(java.util.Collection) or withTmpfs(java.util.Collection) if you want to override the existing values.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTmpfs
```
public LinuxParameters withTmpfs(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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxSwap
```
public void setMaxSwap(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.
    
    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 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.
  - getMaxSwap
```
public Integer getMaxSwap()
```
    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.
    
    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 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.
  - withMaxSwap
```
public LinuxParameters withMaxSwap(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.
    
    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 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSwappiness
```
public void setSwappiness(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.
    
    Parameters:
    
    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.
  - getSwappiness
```
public Integer getSwappiness()
```
    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.
    
    Returns:
    
    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.
  - withSwappiness
```
public LinuxParameters withSwappiness(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public LinuxParameters clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class LinuxParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LinuxParameters

Method Detail

getDevices

setDevices

withDevices

withDevices

setInitProcessEnabled

getInitProcessEnabled

withInitProcessEnabled

isInitProcessEnabled

setSharedMemorySize

getSharedMemorySize

withSharedMemorySize

getTmpfs

setTmpfs

withTmpfs

withTmpfs

setMaxSwap

getMaxSwap

withMaxSwap

setSwappiness

getSwappiness

withSwappiness

toString

equals

hashCode

clone

marshall