@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.
Constructor and Description |
---|
LinuxParameters() |
Modifier and Type | Method and Description |
---|---|
LinuxParameters |
clone() |
boolean |
equals(Object obj) |
List<Device> |
getDevices()
Any of the 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()
You can use this parameter 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 of the 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)
You can use this parameter 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 of the host devices to expose to the container.
|
LinuxParameters |
withDevices(Device... devices)
Any of the 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)
You can use this parameter 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. |
public List<Device> getDevices()
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.
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.
public void setDevices(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.
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.
public LinuxParameters withDevices(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.
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.
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.
public LinuxParameters withDevices(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.
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.
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 in to your container instance and run the following command:
sudo docker version | grep "Server API version"
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"
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 in to your container instance and run the following command:
sudo docker version | grep "Server API version"
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"
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 in to your container instance and run the following command:
sudo docker version | grep "Server API version"
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"
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 in to your container instance and run the following command:
sudo docker version | grep "Server API version"
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"
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
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.
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
/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.
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
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.
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
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.
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
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.
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
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.
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.
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.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
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.
public void setMaxSwap(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.
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.
public Integer getMaxSwap()
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.
--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.
public LinuxParameters withMaxSwap(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.
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.
public void setSwappiness(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.
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.
public Integer getSwappiness()
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.
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.
public LinuxParameters withSwappiness(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.
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.
public String toString()
toString
in class Object
Object.toString()
public LinuxParameters clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.