| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::LinuxParameters; | ||
| 3 | use Moose; | ||
| 4 | has Capabilities => (is => 'ro', isa => 'Paws::ECS::KernelCapabilities', request_name => 'capabilities', traits => ['NameInRequest']); | ||
| 5 | has Devices => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Device]', request_name => 'devices', traits => ['NameInRequest']); | ||
| 6 | has InitProcessEnabled => (is => 'ro', isa => 'Bool', request_name => 'initProcessEnabled', traits => ['NameInRequest']); | ||
| 7 | has MaxSwap => (is => 'ro', isa => 'Int', request_name => 'maxSwap', traits => ['NameInRequest']); | ||
| 8 | has SharedMemorySize => (is => 'ro', isa => 'Int', request_name => 'sharedMemorySize', traits => ['NameInRequest']); | ||
| 9 | has Swappiness => (is => 'ro', isa => 'Int', request_name => 'swappiness', traits => ['NameInRequest']); | ||
| 10 | has Tmpfs => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Tmpfs]', request_name => 'tmpfs', traits => ['NameInRequest']); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::ECS::LinuxParameters | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::ECS::LinuxParameters object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { Capabilities => $value, ..., Tmpfs => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::LinuxParameters object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->Capabilities | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Linux-specific options that are applied to the container, such as Linux | ||
| 43 | KernelCapabilities. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 Capabilities => L<Paws::ECS::KernelCapabilities> | ||
| 49 | |||
| 50 | The Linux capabilities for the container that are added to or dropped | ||
| 51 | from the default configuration provided by Docker. | ||
| 52 | |||
| 53 | For tasks that use the Fargate launch type, C<capabilities> is | ||
| 54 | supported for all platform versions but the C<add> parameter is only | ||
| 55 | supported if using platform version 1.4.0 or later. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Devices => ArrayRef[L<Paws::ECS::Device>] | ||
| 59 | |||
| 60 | Any host devices to expose to the container. This parameter maps to | ||
| 61 | C<Devices> in the Create a container | ||
| 62 | (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate) | ||
| 63 | section of the Docker Remote API | ||
| 64 | (https://docs.docker.com/engine/api/v1.35/) and the C<--device> option | ||
| 65 | to docker run | ||
| 66 | (https://docs.docker.com/engine/reference/run/#security-configuration). | ||
| 67 | |||
| 68 | If you are using tasks that use the Fargate launch type, the C<devices> | ||
| 69 | parameter is not supported. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 InitProcessEnabled => Bool | ||
| 73 | |||
| 74 | Run an C<init> process inside the container that forwards signals and | ||
| 75 | reaps processes. This parameter maps to the C<--init> option to docker | ||
| 76 | run | ||
| 77 | (https://docs.docker.com/engine/reference/run/#security-configuration). | ||
| 78 | This parameter requires version 1.25 of the Docker Remote API or | ||
| 79 | greater on your container instance. To check the Docker Remote API | ||
| 80 | version on your container instance, log in to your container instance | ||
| 81 | and run the following command: C<sudo docker version --format | ||
| 82 | '{{.Server.APIVersion}}'> | ||
| 83 | |||
| 84 | |||
| 85 | =head2 MaxSwap => Int | ||
| 86 | |||
| 87 | The total amount of swap memory (in MiB) a container can use. This | ||
| 88 | parameter will be translated to the C<--memory-swap> option to docker | ||
| 89 | run | ||
| 90 | (https://docs.docker.com/engine/reference/run/#security-configuration) | ||
| 91 | where the value would be the sum of the container memory plus the | ||
| 92 | C<maxSwap> value. | ||
| 93 | |||
| 94 | If a C<maxSwap> value of C<0> is specified, the container will not use | ||
| 95 | swap. Accepted values are C<0> or any positive integer. If the | ||
| 96 | C<maxSwap> parameter is omitted, the container will use the swap | ||
| 97 | configuration for the container instance it is running on. A C<maxSwap> | ||
| 98 | value must be set for the C<swappiness> parameter to be used. | ||
| 99 | |||
| 100 | If you are using tasks that use the Fargate launch type, the C<maxSwap> | ||
| 101 | parameter is not supported. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 SharedMemorySize => Int | ||
| 105 | |||
| 106 | The value for the size (in MiB) of the C</dev/shm> volume. This | ||
| 107 | parameter maps to the C<--shm-size> option to docker run | ||
| 108 | (https://docs.docker.com/engine/reference/run/#security-configuration). | ||
| 109 | |||
| 110 | If you are using tasks that use the Fargate launch type, the | ||
| 111 | C<sharedMemorySize> parameter is not supported. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 Swappiness => Int | ||
| 115 | |||
| 116 | This allows you to tune a container's memory swappiness behavior. A | ||
| 117 | C<swappiness> value of C<0> will cause swapping to not happen unless | ||
| 118 | absolutely necessary. A C<swappiness> value of C<100> will cause pages | ||
| 119 | to be swapped very aggressively. Accepted values are whole numbers | ||
| 120 | between C<0> and C<100>. If the C<swappiness> parameter is not | ||
| 121 | specified, a default value of C<60> is used. If a value is not | ||
| 122 | specified for C<maxSwap> then this parameter is ignored. This parameter | ||
| 123 | maps to the C<--memory-swappiness> option to docker run | ||
| 124 | (https://docs.docker.com/engine/reference/run/#security-configuration). | ||
| 125 | |||
| 126 | If you are using tasks that use the Fargate launch type, the | ||
| 127 | C<swappiness> parameter is not supported. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 Tmpfs => ArrayRef[L<Paws::ECS::Tmpfs>] | ||
| 131 | |||
| 132 | The container path, mount options, and size (in MiB) of the tmpfs | ||
| 133 | mount. This parameter maps to the C<--tmpfs> option to docker run | ||
| 134 | (https://docs.docker.com/engine/reference/run/#security-configuration). | ||
| 135 | |||
| 136 | If you are using tasks that use the Fargate launch type, the C<tmpfs> | ||
| 137 | parameter is not supported. | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head1 SEE ALSO | ||
| 142 | |||
| 143 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 144 | |||
| 145 | =head1 BUGS and CONTRIBUTIONS | ||
| 146 | |||
| 147 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 148 | |||
| 149 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 150 | |||
| 151 | =cut | ||
| 152 |