AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::LinuxParameters Class Reference

#include <LinuxParameters.h>

Public Member Functions

 LinuxParameters ()
 
 LinuxParameters (Aws::Utils::Json::JsonView jsonValue)
 
LinuxParametersoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const KernelCapabilitiesGetCapabilities () const
 
bool CapabilitiesHasBeenSet () const
 
void SetCapabilities (const KernelCapabilities &value)
 
void SetCapabilities (KernelCapabilities &&value)
 
LinuxParametersWithCapabilities (const KernelCapabilities &value)
 
LinuxParametersWithCapabilities (KernelCapabilities &&value)
 
const Aws::Vector< Device > & GetDevices () const
 
bool DevicesHasBeenSet () const
 
void SetDevices (const Aws::Vector< Device > &value)
 
void SetDevices (Aws::Vector< Device > &&value)
 
LinuxParametersWithDevices (const Aws::Vector< Device > &value)
 
LinuxParametersWithDevices (Aws::Vector< Device > &&value)
 
LinuxParametersAddDevices (const Device &value)
 
LinuxParametersAddDevices (Device &&value)
 
bool GetInitProcessEnabled () const
 
bool InitProcessEnabledHasBeenSet () const
 
void SetInitProcessEnabled (bool value)
 
LinuxParametersWithInitProcessEnabled (bool value)
 
int GetSharedMemorySize () const
 
bool SharedMemorySizeHasBeenSet () const
 
void SetSharedMemorySize (int value)
 
LinuxParametersWithSharedMemorySize (int value)
 
const Aws::Vector< Tmpfs > & GetTmpfs () const
 
bool TmpfsHasBeenSet () const
 
void SetTmpfs (const Aws::Vector< Tmpfs > &value)
 
void SetTmpfs (Aws::Vector< Tmpfs > &&value)
 
LinuxParametersWithTmpfs (const Aws::Vector< Tmpfs > &value)
 
LinuxParametersWithTmpfs (Aws::Vector< Tmpfs > &&value)
 
LinuxParametersAddTmpfs (const Tmpfs &value)
 
LinuxParametersAddTmpfs (Tmpfs &&value)
 
int GetMaxSwap () const
 
bool MaxSwapHasBeenSet () const
 
void SetMaxSwap (int value)
 
LinuxParametersWithMaxSwap (int value)
 
int GetSwappiness () const
 
bool SwappinessHasBeenSet () const
 
void SetSwappiness (int value)
 
LinuxParametersWithSwappiness (int value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 35 of file LinuxParameters.h.

Constructor & Destructor Documentation

◆ LinuxParameters() [1/2]

Aws::ECS::Model::LinuxParameters::LinuxParameters ( )

◆ LinuxParameters() [2/2]

Aws::ECS::Model::LinuxParameters::LinuxParameters ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddDevices() [1/2]

LinuxParameters& Aws::ECS::Model::LinuxParameters::AddDevices ( const Device value)
inline

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 are using tasks that use the Fargate launch type, the devices parameter is not supported.

Definition at line 188 of file LinuxParameters.h.

◆ AddDevices() [2/2]

LinuxParameters& Aws::ECS::Model::LinuxParameters::AddDevices ( Device &&  value)
inline

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 are using tasks that use the Fargate launch type, the devices parameter is not supported.

Definition at line 201 of file LinuxParameters.h.

◆ AddTmpfs() [1/2]

LinuxParameters& Aws::ECS::Model::LinuxParameters::AddTmpfs ( const Tmpfs value)
inline

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 are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

Definition at line 347 of file LinuxParameters.h.

◆ AddTmpfs() [2/2]

LinuxParameters& Aws::ECS::Model::LinuxParameters::AddTmpfs ( Tmpfs &&  value)
inline

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 are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

Definition at line 356 of file LinuxParameters.h.

◆ CapabilitiesHasBeenSet()

bool Aws::ECS::Model::LinuxParameters::CapabilitiesHasBeenSet ( ) const
inline

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.

Definition at line 60 of file LinuxParameters.h.

◆ DevicesHasBeenSet()

bool Aws::ECS::Model::LinuxParameters::DevicesHasBeenSet ( ) const
inline

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 are using tasks that use the Fargate launch type, the devices parameter is not supported.

Definition at line 123 of file LinuxParameters.h.

◆ GetCapabilities()

const KernelCapabilities& Aws::ECS::Model::LinuxParameters::GetCapabilities ( ) const
inline

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.

Definition at line 51 of file LinuxParameters.h.

◆ GetDevices()

const Aws::Vector<Device>& Aws::ECS::Model::LinuxParameters::GetDevices ( ) const
inline

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 are using tasks that use the Fargate launch type, the devices parameter is not supported.

Definition at line 110 of file LinuxParameters.h.

◆ GetInitProcessEnabled()

bool Aws::ECS::Model::LinuxParameters::GetInitProcessEnabled ( ) const
inline

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}}'

Definition at line 213 of file LinuxParameters.h.

◆ GetMaxSwap()

int Aws::ECS::Model::LinuxParameters::GetMaxSwap ( ) const
inline

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 are using tasks that use the Fargate launch type, the maxSwap parameter is not supported.

Definition at line 373 of file LinuxParameters.h.

◆ GetSharedMemorySize()

int Aws::ECS::Model::LinuxParameters::GetSharedMemorySize ( ) const
inline

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.

Definition at line 256 of file LinuxParameters.h.

◆ GetSwappiness()

int Aws::ECS::Model::LinuxParameters::GetSwappiness ( ) const
inline

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 are using tasks that use the Fargate launch type, the swappiness parameter is not supported.

Definition at line 438 of file LinuxParameters.h.

◆ GetTmpfs()

const Aws::Vector<Tmpfs>& Aws::ECS::Model::LinuxParameters::GetTmpfs ( ) const
inline

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 are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

Definition at line 293 of file LinuxParameters.h.

◆ InitProcessEnabledHasBeenSet()

bool Aws::ECS::Model::LinuxParameters::InitProcessEnabledHasBeenSet ( ) const
inline

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}}'

Definition at line 224 of file LinuxParameters.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::LinuxParameters::Jsonize ( ) const

◆ MaxSwapHasBeenSet()

bool Aws::ECS::Model::LinuxParameters::MaxSwapHasBeenSet ( ) const
inline

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 are using tasks that use the Fargate launch type, the maxSwap parameter is not supported.

Definition at line 389 of file LinuxParameters.h.

◆ operator=()

LinuxParameters& Aws::ECS::Model::LinuxParameters::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetCapabilities() [1/2]

void Aws::ECS::Model::LinuxParameters::SetCapabilities ( const KernelCapabilities value)
inline

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.

Definition at line 69 of file LinuxParameters.h.

◆ SetCapabilities() [2/2]

void Aws::ECS::Model::LinuxParameters::SetCapabilities ( KernelCapabilities &&  value)
inline

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.

Definition at line 78 of file LinuxParameters.h.

◆ SetDevices() [1/2]

void Aws::ECS::Model::LinuxParameters::SetDevices ( const Aws::Vector< Device > &  value)
inline

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 are using tasks that use the Fargate launch type, the devices parameter is not supported.

Definition at line 136 of file LinuxParameters.h.

◆ SetDevices() [2/2]

void Aws::ECS::Model::LinuxParameters::SetDevices ( Aws::Vector< Device > &&  value)
inline

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 are using tasks that use the Fargate launch type, the devices parameter is not supported.

Definition at line 149 of file LinuxParameters.h.

◆ SetInitProcessEnabled()

void Aws::ECS::Model::LinuxParameters::SetInitProcessEnabled ( bool  value)
inline

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}}'

Definition at line 235 of file LinuxParameters.h.

◆ SetMaxSwap()

void Aws::ECS::Model::LinuxParameters::SetMaxSwap ( int  value)
inline

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 are using tasks that use the Fargate launch type, the maxSwap parameter is not supported.

Definition at line 405 of file LinuxParameters.h.

◆ SetSharedMemorySize()

void Aws::ECS::Model::LinuxParameters::SetSharedMemorySize ( int  value)
inline

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.

Definition at line 274 of file LinuxParameters.h.

◆ SetSwappiness()

void Aws::ECS::Model::LinuxParameters::SetSwappiness ( int  value)
inline

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 are using tasks that use the Fargate launch type, the swappiness parameter is not supported.

Definition at line 470 of file LinuxParameters.h.

◆ SetTmpfs() [1/2]

void Aws::ECS::Model::LinuxParameters::SetTmpfs ( const Aws::Vector< Tmpfs > &  value)
inline

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 are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

Definition at line 311 of file LinuxParameters.h.

◆ SetTmpfs() [2/2]

void Aws::ECS::Model::LinuxParameters::SetTmpfs ( Aws::Vector< Tmpfs > &&  value)
inline

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 are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

Definition at line 320 of file LinuxParameters.h.

◆ SharedMemorySizeHasBeenSet()

bool Aws::ECS::Model::LinuxParameters::SharedMemorySizeHasBeenSet ( ) const
inline

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.

Definition at line 265 of file LinuxParameters.h.

◆ SwappinessHasBeenSet()

bool Aws::ECS::Model::LinuxParameters::SwappinessHasBeenSet ( ) const
inline

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 are using tasks that use the Fargate launch type, the swappiness parameter is not supported.

Definition at line 454 of file LinuxParameters.h.

◆ TmpfsHasBeenSet()

bool Aws::ECS::Model::LinuxParameters::TmpfsHasBeenSet ( ) const
inline

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 are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

Definition at line 302 of file LinuxParameters.h.

◆ WithCapabilities() [1/2]

LinuxParameters& Aws::ECS::Model::LinuxParameters::WithCapabilities ( const KernelCapabilities value)
inline

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.

Definition at line 87 of file LinuxParameters.h.

◆ WithCapabilities() [2/2]

LinuxParameters& Aws::ECS::Model::LinuxParameters::WithCapabilities ( KernelCapabilities &&  value)
inline

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.

Definition at line 96 of file LinuxParameters.h.

◆ WithDevices() [1/2]

LinuxParameters& Aws::ECS::Model::LinuxParameters::WithDevices ( const Aws::Vector< Device > &  value)
inline

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 are using tasks that use the Fargate launch type, the devices parameter is not supported.

Definition at line 162 of file LinuxParameters.h.

◆ WithDevices() [2/2]

LinuxParameters& Aws::ECS::Model::LinuxParameters::WithDevices ( Aws::Vector< Device > &&  value)
inline

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 are using tasks that use the Fargate launch type, the devices parameter is not supported.

Definition at line 175 of file LinuxParameters.h.

◆ WithInitProcessEnabled()

LinuxParameters& Aws::ECS::Model::LinuxParameters::WithInitProcessEnabled ( bool  value)
inline

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}}'

Definition at line 246 of file LinuxParameters.h.

◆ WithMaxSwap()

LinuxParameters& Aws::ECS::Model::LinuxParameters::WithMaxSwap ( int  value)
inline

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 are using tasks that use the Fargate launch type, the maxSwap parameter is not supported.

Definition at line 421 of file LinuxParameters.h.

◆ WithSharedMemorySize()

LinuxParameters& Aws::ECS::Model::LinuxParameters::WithSharedMemorySize ( int  value)
inline

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.

Definition at line 283 of file LinuxParameters.h.

◆ WithSwappiness()

LinuxParameters& Aws::ECS::Model::LinuxParameters::WithSwappiness ( int  value)
inline

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 are using tasks that use the Fargate launch type, the swappiness parameter is not supported.

Definition at line 486 of file LinuxParameters.h.

◆ WithTmpfs() [1/2]

LinuxParameters& Aws::ECS::Model::LinuxParameters::WithTmpfs ( const Aws::Vector< Tmpfs > &  value)
inline

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 are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

Definition at line 329 of file LinuxParameters.h.

◆ WithTmpfs() [2/2]

LinuxParameters& Aws::ECS::Model::LinuxParameters::WithTmpfs ( Aws::Vector< Tmpfs > &&  value)
inline

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 are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

Definition at line 338 of file LinuxParameters.h.


The documentation for this class was generated from the following file: