Class: Aws::Batch::Types::LinuxParameters
- Inherits:
-
Struct
- Object
- Struct
- Aws::Batch::Types::LinuxParameters
- Defined in:
- gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb
Overview
When making an API call, you may pass LinuxParameters data as a 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.
Constant Summary collapse
- SENSITIVE =
[]
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.
3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3193 class LinuxParameters < Struct.new( :devices, :init_process_enabled, :shared_memory_size, :tmpfs, :max_swap, :swappiness) SENSITIVE = [] include Aws::Structure end |
#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"
3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3193 class LinuxParameters < Struct.new( :devices, :init_process_enabled, :shared_memory_size, :tmpfs, :max_swap, :swappiness) SENSITIVE = [] include Aws::Structure end |
#max_swap ⇒ Integer
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 it is running on. A
maxSwap
value must be set for the swappiness
parameter to be
used.
3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3193 class LinuxParameters < Struct.new( :devices, :init_process_enabled, :shared_memory_size, :tmpfs, :max_swap, :swappiness) SENSITIVE = [] include Aws::Structure end |
#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.
3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3193 class LinuxParameters < Struct.new( :devices, :init_process_enabled, :shared_memory_size, :tmpfs, :max_swap, :swappiness) SENSITIVE = [] include Aws::Structure end |
#swappiness ⇒ Integer
This allows you to tune a container's memory swappiness behavior. A
swappiness
value of 0
causes swapping not to happen unless
absolutely necessary. A swappiness
value of 100
causes pages to
be swapped very aggressively. Accepted 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.
The Amazon ECS optimized AMIs don't have swap enabled by default. 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
andswappiness
parameters are omitted from a job definition, each container will have a defaultswappiness
value of 60 and the total swap usage will be limited to two times the memory reservation of the container.
3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3193 class LinuxParameters < Struct.new( :devices, :init_process_enabled, :shared_memory_size, :tmpfs, :max_swap, :swappiness) SENSITIVE = [] include Aws::Structure end |
#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.
3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 |
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3193 class LinuxParameters < Struct.new( :devices, :init_process_enabled, :shared_memory_size, :tmpfs, :max_swap, :swappiness) SENSITIVE = [] include Aws::Structure end |