Class: Aws::Batch::Types::LinuxParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb

Overview

Note:

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

Instance Attribute Details

#devicesArray<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.

Returns:



2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2488

class LinuxParameters < Struct.new(
  :devices,
  :init_process_enabled,
  :shared_memory_size,
  :tmpfs,
  :max_swap,
  :swappiness)
  SENSITIVE = []
  include Aws::Structure
end

#init_process_enabledBoolean

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:

  • (Boolean)


2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2488

class LinuxParameters < Struct.new(
  :devices,
  :init_process_enabled,
  :shared_memory_size,
  :tmpfs,
  :max_swap,
  :swappiness)
  SENSITIVE = []
  include Aws::Structure
end

#max_swapInteger

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.

Returns:

  • (Integer)


2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2488

class LinuxParameters < Struct.new(
  :devices,
  :init_process_enabled,
  :shared_memory_size,
  :tmpfs,
  :max_swap,
  :swappiness)
  SENSITIVE = []
  include Aws::Structure
end

#shared_memory_sizeInteger

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

Returns:

  • (Integer)


2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2488

class LinuxParameters < Struct.new(
  :devices,
  :init_process_enabled,
  :shared_memory_size,
  :tmpfs,
  :max_swap,
  :swappiness)
  SENSITIVE = []
  include Aws::Structure
end

#swappinessInteger

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:

  • (Integer)


2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2488

class LinuxParameters < Struct.new(
  :devices,
  :init_process_enabled,
  :shared_memory_size,
  :tmpfs,
  :max_swap,
  :swappiness)
  SENSITIVE = []
  include Aws::Structure
end

#tmpfsArray<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.

Returns:



2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 2488

class LinuxParameters < Struct.new(
  :devices,
  :init_process_enabled,
  :shared_memory_size,
  :tmpfs,
  :max_swap,
  :swappiness)
  SENSITIVE = []
  include Aws::Structure
end