/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.ecs.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* The Linux-specific options that are applied to the container, such as Linux KernelCapabilities. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class LinuxParameters implements Serializable, Cloneable, StructuredPojo { /** ** 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.
*
* 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.
*
* 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}}'
*
* 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.
*
* 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.
*
* 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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
* 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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
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.
*
* 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.
*
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.
*
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setDevices(java.util.Collection)} or {@link #withDevices(java.util.Collection)} if you want to override * the existing values. *
* * @param devices * Any host devices to expose to the container. This parameter maps toDevices
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.
*
* 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.
*
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.
*
* 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}}'
*
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}}'
*/
public void setInitProcessEnabled(Boolean initProcessEnabled) {
this.initProcessEnabled = 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}}'
*
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}}'
*/
public Boolean getInitProcessEnabled() {
return this.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}}'
*
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}}'
* @return Returns a reference to this object so that method calls can be chained together.
*/
public LinuxParameters withInitProcessEnabled(Boolean initProcessEnabled) {
setInitProcessEnabled(initProcessEnabled);
return this;
}
/**
*
* 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}}'
*
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}}'
*/
public Boolean isInitProcessEnabled() {
return this.initProcessEnabled;
}
/**
*
* 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.
*
/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.
*
* 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.
*
/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.
*
* 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.
*
/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.
*
* 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.
*
--tmpfs
option to docker run.
* If you're using tasks that use the Fargate launch type, the tmpfs
parameter isn't supported.
*
* 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.
*
--tmpfs
option to docker run.
* If you're using tasks that use the Fargate launch type, the tmpfs
parameter isn't supported.
*
* 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.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTmpfs(java.util.Collection)} or {@link #withTmpfs(java.util.Collection)} if you want to override the * existing values. *
* * @param 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.
*
* 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.
*
--tmpfs
option to docker run.
* If you're using tasks that use the Fargate launch type, the tmpfs
parameter isn't supported.
*
* 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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
--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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
* 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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
--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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
* 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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
--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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
* 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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
* 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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
* 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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*
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.
*
* If you're using tasks on Amazon Linux 2023 the swappiness
parameter isn't supported.
*