libZSservicesZSamazonka-batchZSamazonka-batch
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Batch.Types.LinuxParameters

Description

 
Synopsis

Documentation

data LinuxParameters Source #

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

See: newLinuxParameters smart constructor.

Constructors

LinuxParameters' 

Fields

  • sharedMemorySize :: Maybe Int

    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 and shouldn't be provided.

  • initProcessEnabled :: Maybe Bool

    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"

  • tmpfs :: Maybe [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 and shouldn't be provided.

  • swappiness :: Maybe Int

    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 and swappiness parameters are omitted from a job definition, each container will have a default swappiness value of 60, and the total swap usage will be limited to two times the memory reservation of the container.

    This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

  • devices :: Maybe [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.

    This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

  • maxSwap :: Maybe Int

    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.

    This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Instances

Instances details
Eq LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Methods

(==) :: LinuxParameters -> LinuxParameters -> Bool #

(/=) :: LinuxParameters -> LinuxParameters -> Bool #

Read LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Methods

readsPrec :: Int -> ReadS LinuxParameters #

readList :: ReadS [LinuxParameters] #

readPrec :: ReadPrec LinuxParameters #

readListPrec :: ReadPrec [LinuxParameters] #

Show LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Methods

showsPrec :: Int -> LinuxParameters -> ShowS #

show :: LinuxParameters -> String #

showList :: [LinuxParameters] -> ShowS #

Generic LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Associated Types

type Rep LinuxParameters :: Type -> Type #

Methods

from :: LinuxParameters -> Rep LinuxParameters x #

to :: Rep LinuxParameters x -> LinuxParameters #

NFData LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Methods

rnf :: LinuxParameters -> () #

Hashable LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Methods

hashWithSalt :: Int -> LinuxParameters -> Int #

hash :: LinuxParameters -> Int #

ToJSON LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Methods

toJSON :: LinuxParameters -> Value #

toEncoding :: LinuxParameters -> Encoding #

toJSONList :: [LinuxParameters] -> Value #

toEncodingList :: [LinuxParameters] -> Encoding #

FromJSON LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

Methods

parseJSON :: Value -> Parser LinuxParameters #

parseJSONList :: Value -> Parser [LinuxParameters] #

type Rep LinuxParameters Source # 
Instance details

Defined in Amazonka.Batch.Types.LinuxParameters

type Rep LinuxParameters = D1 ('MetaData "LinuxParameters" "Amazonka.Batch.Types.LinuxParameters" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "LinuxParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sharedMemorySize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "initProcessEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "tmpfs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tmpfs])))) :*: (S1 ('MetaSel ('Just "swappiness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "devices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Device])) :*: S1 ('MetaSel ('Just "maxSwap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newLinuxParameters :: LinuxParameters Source #

Create a value of LinuxParameters with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sharedMemorySize:LinuxParameters', linuxParameters_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 and shouldn't be provided.

$sel:initProcessEnabled:LinuxParameters', linuxParameters_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 into your container instance and run the following command: sudo docker version | grep "Server API version"

$sel:tmpfs:LinuxParameters', linuxParameters_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 and shouldn't be provided.

$sel:swappiness:LinuxParameters', linuxParameters_swappiness - 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 and swappiness parameters are omitted from a job definition, each container will have a default swappiness value of 60, and the total swap usage will be limited to two times the memory reservation of the container.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

$sel:devices:LinuxParameters', linuxParameters_devices - 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.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

$sel:maxSwap:LinuxParameters', linuxParameters_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 it is 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 and shouldn't be provided.

linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int) Source #

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 and shouldn't be provided.

linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool) Source #

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"

linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs]) Source #

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 and shouldn't be provided.

linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int) Source #

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 and swappiness parameters are omitted from a job definition, each container will have a default swappiness value of 60, and the total swap usage will be limited to two times the memory reservation of the container.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device]) Source #

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.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int) Source #

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.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.