Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data LinuxParameters = LinuxParameters' {}
- newLinuxParameters :: LinuxParameters
- linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device])
- linuxParameters_initProcessEnabled :: Lens' LinuxParameters (Maybe Bool)
- linuxParameters_maxSwap :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_sharedMemorySize :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int)
- linuxParameters_tmpfs :: Lens' LinuxParameters (Maybe [Tmpfs])
Documentation
data LinuxParameters Source #
Linux-specific modifications that are applied to the container, such as details for device mappings.
See: newLinuxParameters
smart constructor.
LinuxParameters' | |
|
Instances
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:devices:LinuxParameters'
, linuxParameters_devices
- 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 and the
--device
option to
docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
$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 in to your container instance and run the
following command: sudo docker version | grep "Server API version"
$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 that it's 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. Don't provide it for these jobs.
$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. Don't provide it for these jobs.
$sel:swappiness:LinuxParameters'
, linuxParameters_swappiness
- 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.
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?
- 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 has a defaultswappiness
value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
$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. Don't provide this parameter for this resource type.
linuxParameters_devices :: Lens' LinuxParameters (Maybe [Device]) Source #
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 and the
--device
option to
docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
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 in to your container instance and run the
following command: sudo docker version | grep "Server API version"
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 that it's 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. Don't provide it for these jobs.
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. Don't provide it for these jobs.
linuxParameters_swappiness :: Lens' LinuxParameters (Maybe Int) Source #
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.
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?
- 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 has a defaultswappiness
value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
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. Don't provide this parameter for this resource type.