Aws::Batch::Model::LinuxParameters Class Reference

#include <LinuxParameters.h>

Public Member Functions

AWS_BATCH_API LinuxParameters ()=default

 

AWS_BATCH_API LinuxParameters (Aws::Utils::Json::JsonView jsonValue)

 

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

 

AWS_BATCH_API Aws::Utils::Json::JsonValue Jsonize () const

 

const Aws::Vector< Device > & GetDevices () const

 

bool DevicesHasBeenSet () const

 

template<typename DevicesT = Aws::Vector<Device>>

void SetDevices (DevicesT &&value)

 

template<typename DevicesT = Aws::Vector<Device>>

LinuxParameters & WithDevices (DevicesT &&value)

 

template<typename DevicesT = Device>

LinuxParameters & AddDevices (DevicesT &&value)

 

bool GetInitProcessEnabled () const

 

bool InitProcessEnabledHasBeenSet () const

 

void SetInitProcessEnabled (bool value)

 

LinuxParameters & WithInitProcessEnabled (bool value)

 

int GetSharedMemorySize () const

 

bool SharedMemorySizeHasBeenSet () const

 

void SetSharedMemorySize (int value)

 

LinuxParameters & WithSharedMemorySize (int value)

 

const Aws::Vector< Tmpfs > & GetTmpfs () const

 

bool TmpfsHasBeenSet () const

 

template<typename TmpfsT = Aws::Vector<Tmpfs>>

void SetTmpfs (TmpfsT &&value)

 

template<typename TmpfsT = Aws::Vector<Tmpfs>>

LinuxParameters & WithTmpfs (TmpfsT &&value)

 

template<typename TmpfsT = Tmpfs>

LinuxParameters & AddTmpfs (TmpfsT &&value)

 

int GetMaxSwap () const

 

bool MaxSwapHasBeenSet () const

 

void SetMaxSwap (int value)

 

LinuxParameters & WithMaxSwap (int value)

 

int GetSwappiness () const

 

bool SwappinessHasBeenSet () const

 

void SetSwappiness (int value)

 

LinuxParameters & WithSwappiness (int value)

 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 34 of file LinuxParameters.h.

Constructor & Destructor Documentation

LinuxParameters() [1/2]

AWS_BATCH_API Aws::Batch::Model::LinuxParameters::LinuxParameters ( )

default

LinuxParameters() [2/2]

AWS_BATCH_API Aws::Batch::Model::LinuxParameters::LinuxParameters ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

AddDevices()

template<typename DevicesT = Device>

LinuxParameters & Aws::Batch::Model::LinuxParameters::AddDevices ( DevicesT &&  value)

inline

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.

Definition at line 62 of file LinuxParameters.h.

AddTmpfs()

template<typename TmpfsT = Tmpfs>

LinuxParameters & Aws::Batch::Model::LinuxParameters::AddTmpfs ( TmpfsT &&  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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

Definition at line 110 of file LinuxParameters.h.

DevicesHasBeenSet()

bool Aws::Batch::Model::LinuxParameters::DevicesHasBeenSet ( ) const

inline

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.

Definition at line 56 of file LinuxParameters.h.

GetDevices()

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

inline

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.

Definition at line 55 of file LinuxParameters.h.

GetInitProcessEnabled()

bool Aws::Batch::Model::LinuxParameters::GetInitProcessEnabled ( ) const

inline

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"

Definition at line 75 of file LinuxParameters.h.

GetMaxSwap()

int Aws::Batch::Model::LinuxParameters::GetMaxSwap ( ) const

inline

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 on which it runs. 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.

Definition at line 130 of file LinuxParameters.h.

GetSharedMemorySize()

int Aws::Batch::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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Definition at line 89 of file LinuxParameters.h.

GetSwappiness()

int Aws::Batch::Model::LinuxParameters::GetSwappiness ( ) const

inline

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 and swappiness parameters are omitted from a job definition, each container has a default swappiness value of

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

Definition at line 167 of file LinuxParameters.h.

GetTmpfs()

const Aws::Vector< Tmpfs > & Aws::Batch::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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

Definition at line 103 of file LinuxParameters.h.

InitProcessEnabledHasBeenSet()

bool Aws::Batch::Model::LinuxParameters::InitProcessEnabledHasBeenSet ( ) const

inline

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"

Definition at line 76 of file LinuxParameters.h.

Jsonize()

AWS_BATCH_API Aws::Utils::Json::JsonValue Aws::Batch::Model::LinuxParameters::Jsonize ( ) const

MaxSwapHasBeenSet()

bool Aws::Batch::Model::LinuxParameters::MaxSwapHasBeenSet ( ) const

inline

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 on which it runs. 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.

Definition at line 131 of file LinuxParameters.h.

operator=()

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

SetDevices()

template<typename DevicesT = Aws::Vector<Device>>

void Aws::Batch::Model::LinuxParameters::SetDevices ( DevicesT &&  value)

inline

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.

Definition at line 58 of file LinuxParameters.h.

SetInitProcessEnabled()

void Aws::Batch::Model::LinuxParameters::SetInitProcessEnabled ( bool  value)

inline

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"

Definition at line 77 of file LinuxParameters.h.

SetMaxSwap()

void Aws::Batch::Model::LinuxParameters::SetMaxSwap ( int  value)

inline

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 on which it runs. 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.

Definition at line 132 of file LinuxParameters.h.

SetSharedMemorySize()

void Aws::Batch::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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Definition at line 91 of file LinuxParameters.h.

SetSwappiness()

void Aws::Batch::Model::LinuxParameters::SetSwappiness ( int  value)

inline

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 and swappiness parameters are omitted from a job definition, each container has a default swappiness value of

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

Definition at line 169 of file LinuxParameters.h.

SetTmpfs()

template<typename TmpfsT = Aws::Vector<Tmpfs>>

void Aws::Batch::Model::LinuxParameters::SetTmpfs ( TmpfsT &&  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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

Definition at line 106 of file LinuxParameters.h.

SharedMemorySizeHasBeenSet()

bool Aws::Batch::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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Definition at line 90 of file LinuxParameters.h.

SwappinessHasBeenSet()

bool Aws::Batch::Model::LinuxParameters::SwappinessHasBeenSet ( ) const

inline

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 and swappiness parameters are omitted from a job definition, each container has a default swappiness value of

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

Definition at line 168 of file LinuxParameters.h.

TmpfsHasBeenSet()

bool Aws::Batch::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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

Definition at line 104 of file LinuxParameters.h.

WithDevices()

template<typename DevicesT = Aws::Vector<Device>>

LinuxParameters & Aws::Batch::Model::LinuxParameters::WithDevices ( DevicesT &&  value)

inline

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.

Definition at line 60 of file LinuxParameters.h.

WithInitProcessEnabled()

LinuxParameters & Aws::Batch::Model::LinuxParameters::WithInitProcessEnabled ( bool  value)

inline

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"

Definition at line 78 of file LinuxParameters.h.

WithMaxSwap()

LinuxParameters & Aws::Batch::Model::LinuxParameters::WithMaxSwap ( int  value)

inline

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 on which it runs. 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.

Definition at line 133 of file LinuxParameters.h.

WithSharedMemorySize()

LinuxParameters & Aws::Batch::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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

Definition at line 92 of file LinuxParameters.h.

WithSwappiness()

LinuxParameters & Aws::Batch::Model::LinuxParameters::WithSwappiness ( int  value)

inline

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 and swappiness parameters are omitted from a job definition, each container has a default swappiness value of

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

Definition at line 170 of file LinuxParameters.h.

WithTmpfs()

template<typename TmpfsT = Aws::Vector<Tmpfs>>

LinuxParameters & Aws::Batch::Model::LinuxParameters::WithTmpfs ( TmpfsT &&  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.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

Definition at line 108 of file LinuxParameters.h.

---

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

• generated/src/aws-cpp-sdk-batch/include/aws/batch/model/LinuxParameters.h