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

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

Overview

Linux-specific modifications that are applied to the container, such as details for device mappings.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#devices ⇒ Array<Types::Device>

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][2

and the ‘–device` option to [docker run].

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t provide it for these jobs.

</note>

[1]: docs.docker.com/engine/api/v1.23/#create-a-container [2]: docs.docker.com/engine/api/v1.23/ [3]: docs.docker.com/engine/reference/run/

Returns:



5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
 
# File 'lib/aws-sdk-batch/types.rb', line 5509

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 in to your container instance and run the following command: `sudo docker version | grep “Server API version”`

[1]: docs.docker.com/engine/reference/run/

Returns:

  • (Boolean) 


5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
 
# File 'lib/aws-sdk-batch/types.rb', line 5509

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 that it’s running on. A ‘maxSwap` value must be set for the `swappiness` parameter to be used.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t provide it for these jobs.

</note>

[1]: docs.docker.com/engine/reference/run/ [2]: docs.docker.com/config/containers/resource_constraints/#–memory-swap-details

Returns:

  • (Integer) 


5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
 
# File 'lib/aws-sdk-batch/types.rb', line 5509

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].

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t provide it for these jobs.

</note>

[1]: docs.docker.com/engine/reference/run/

Returns:

  • (Integer) 


5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
 
# File 'lib/aws-sdk-batch/types.rb', line 5509

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

#swappiness ⇒ Integer

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.

    <note markdown=“1”> 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?]

    </note>

  • 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

    1. Moreover, the total swap usage is limited to two times the

    memory reservation of the container.

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t provide it for these jobs.

</note>

[1]: docs.docker.com/engine/reference/run/ [2]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html [3]: aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/

Returns:

  • (Integer) 


5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
 
# File 'lib/aws-sdk-batch/types.rb', line 5509

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].

<note markdown=“1”> This parameter isn’t applicable to jobs that are running on Fargate resources. Don’t provide this parameter for this resource type.

</note>

[1]: docs.docker.com/engine/reference/run/

Returns:



5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
 
# File 'lib/aws-sdk-batch/types.rb', line 5509

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