You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Batch::Types::LinuxParameters
- Inherits:
-
Struct
- Object
- Struct
- Aws::Batch::Types::LinuxParameters
- Defined in:
- (unknown)
Overview
When passing LinuxParameters as input to an Aws::Client method, you can use a vanilla Hash:
{
devices: [
{
host_path: "String", # required
container_path: "String",
permissions: ["READ"], # accepts READ, WRITE, MKNOD
},
],
init_process_enabled: false,
shared_memory_size: 1,
tmpfs: [
{
container_path: "String", # required
size: 1, # required
mount_options: ["String"],
},
],
max_swap: 1,
swappiness: 1,
}
Linux-specific modifications that are applied to the container, such as details for device mappings.
Returned by:
Instance Attribute Summary collapse
-
#devices ⇒ Array<Types::Device>
Any host devices to expose to the container.
-
#init_process_enabled ⇒ Boolean
If true, run an
init
process inside the container that forwards signals and reaps processes. -
#max_swap ⇒ Integer
The total amount of swap memory (in MiB) a container can use.
-
#shared_memory_size ⇒ Integer
The value for the size (in MiB) of the
/dev/shm
volume. -
#swappiness ⇒ Integer
This allows you to tune a container\'s memory swappiness behavior.
-
#tmpfs ⇒ Array<Types::Tmpfs>
The container path, mount options, and size (in MiB) of the tmpfs mount.
Instance Attribute Details
#devices ⇒ Array<Types::Device>
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.
#init_process_enabled ⇒ Boolean
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"
#max_swap ⇒ Integer
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. For more information, see --memory-swap
details in the Docker documentation.
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.
#shared_memory_size ⇒ Integer
The value for the size (in MiB) of the /dev/shm
volume. This parameter
maps to the --shm-size
option to docker run.
#swappiness ⇒ Integer
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.
#tmpfs ⇒ Array<Types::Tmpfs>
The container path, mount options, and size (in MiB) of the tmpfs mount.
This parameter maps to the --tmpfs
option to docker run.