Amazonka.ECS.Types.LinuxParameters

Documentation

data LinuxParameters

Linux-specific options that are applied to the container, such as Linux KernelCapabilities.

See: newLinuxParameters smart constructor.

Constructors

LinuxParameters'

Fields

• capabilities :: Maybe KernelCapabilities

  The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

  For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.

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

  If you're using tasks that use the Fargate launch type, the devices parameter isn't supported.

• initProcessEnabled :: Maybe Bool

  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 --format '{{.Server.APIVersion}}'

• maxSwap :: Maybe Int

  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.

  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.

  If you're using tasks that use the Fargate launch type, the maxSwap parameter isn't supported.

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

  If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

• swappiness :: Maybe Int

  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.

  If you're using tasks that use the Fargate launch type, the swappiness parameter isn't supported.

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

  If you're using tasks that use the Fargate launch type, the tmpfs parameter isn't supported.

Instances

FromJSON LinuxParameters

Defined in Amazonka.ECS.Types.LinuxParameters

Methods

parseJSON :: Value -> Parser LinuxParameters

parseJSONList :: Value -> Parser [LinuxParameters]

ToJSON LinuxParameters

Defined in Amazonka.ECS.Types.LinuxParameters

Methods

toJSON :: LinuxParameters -> Value

toEncoding :: LinuxParameters -> Encoding

toJSONList :: [LinuxParameters] -> Value

toEncodingList :: [LinuxParameters] -> Encoding

Generic LinuxParameters

Defined in Amazonka.ECS.Types.LinuxParameters

Associated Types

type Rep LinuxParameters :: Type -> Type

Methods

from :: LinuxParameters -> Rep LinuxParameters x

to :: Rep LinuxParameters x -> LinuxParameters

Read LinuxParameters

Defined in Amazonka.ECS.Types.LinuxParameters

Methods

readsPrec :: Int -> ReadS LinuxParameters

readList :: ReadS [LinuxParameters]

readPrec :: ReadPrec LinuxParameters

readListPrec :: ReadPrec [LinuxParameters]

Show LinuxParameters

Defined in Amazonka.ECS.Types.LinuxParameters

Methods

showsPrec :: Int -> LinuxParameters -> ShowS

show :: LinuxParameters -> String

showList :: [LinuxParameters] -> ShowS

NFData LinuxParameters

Defined in Amazonka.ECS.Types.LinuxParameters

Methods

rnf :: LinuxParameters -> ()

Eq LinuxParameters

Defined in Amazonka.ECS.Types.LinuxParameters

Methods

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

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

Hashable LinuxParameters

Defined in Amazonka.ECS.Types.LinuxParameters

Methods

hashWithSalt :: Int -> LinuxParameters -> Int

hash :: LinuxParameters -> Int

type Rep LinuxParameters

Defined in Amazonka.ECS.Types.LinuxParameters

type Rep LinuxParameters = D1 ('MetaData "LinuxParameters" "Amazonka.ECS.Types.LinuxParameters" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "LinuxParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "capabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KernelCapabilities)) :*: (S1 ('MetaSel ('Just "devices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Device])) :*: S1 ('MetaSel ('Just "initProcessEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "maxSwap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "sharedMemorySize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "swappiness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "tmpfs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tmpfs]))))))

newLinuxParameters :: LinuxParameters

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:capabilities:LinuxParameters', linuxParameters_capabilities - The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.

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

If you're using tasks that use the Fargate launch type, the devices parameter isn't supported.

$sel:initProcessEnabled:LinuxParameters', linuxParameters_initProcessEnabled - 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 --format '{{.Server.APIVersion}}'

$sel:maxSwap:LinuxParameters', linuxParameters_maxSwap - 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.

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.

If you're using tasks that use the Fargate launch type, the maxSwap parameter isn't supported.

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

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

$sel:swappiness:LinuxParameters', linuxParameters_swappiness - 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.

If you're using tasks that use the Fargate launch type, the swappiness parameter isn't supported.

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

If you're using tasks that use the Fargate launch type, the tmpfs parameter isn't supported.

linuxParameters_capabilities :: Lens' LinuxParameters (Maybe KernelCapabilities)

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

For tasks that use the Fargate launch type, capabilities is supported for all platform versions but the add parameter is only supported if using platform version 1.4.0 or later.

linuxParameters_devices :: Lens' LinuxParameters (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.

If you're using tasks that use the Fargate launch type, the devices parameter isn't supported.

linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool)

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 --format '{{.Server.APIVersion}}'

linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int)

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.

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.

If you're using tasks that use the Fargate launch type, the maxSwap parameter isn't supported.

linuxParameters_sharedMemorySize :: Lens' LinuxParameters (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.

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int)

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.

If you're using tasks that use the Fargate launch type, the swappiness parameter isn't supported.

linuxParameters_tmpfs :: Lens' LinuxParameters (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.

If you're using tasks that use the Fargate launch type, the tmpfs parameter isn't supported.