blib/lib/Paws/Batch/ContainerDetail.pm untested

filter: Statementstmt 0.0% 0 / 55 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 56 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Batch::ContainerDetail;
3 use Moose;
4 has Command => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'command', traits => ['NameInRequest']);
5 has ContainerInstanceArn => (is => 'ro', isa => 'Str', request_name => 'containerInstanceArn', traits => ['NameInRequest']);
6 has Environment => (is => 'ro', isa => 'ArrayRef[Paws::Batch::KeyValuePair]', request_name => 'environment', traits => ['NameInRequest']);
7 has ExecutionRoleArn => (is => 'ro', isa => 'Str', request_name => 'executionRoleArn', traits => ['NameInRequest']);
8 has ExitCode => (is => 'ro', isa => 'Int', request_name => 'exitCode', traits => ['NameInRequest']);
9 has FargatePlatformConfiguration => (is => 'ro', isa => 'Paws::Batch::FargatePlatformConfiguration', request_name => 'fargatePlatformConfiguration', traits => ['NameInRequest']);
10 has Image => (is => 'ro', isa => 'Str', request_name => 'image', traits => ['NameInRequest']);
11 has InstanceType => (is => 'ro', isa => 'Str', request_name => 'instanceType', traits => ['NameInRequest']);
12 has JobRoleArn => (is => 'ro', isa => 'Str', request_name => 'jobRoleArn', traits => ['NameInRequest']);
13 has LinuxParameters => (is => 'ro', isa => 'Paws::Batch::LinuxParameters', request_name => 'linuxParameters', traits => ['NameInRequest']);
14 has LogConfiguration => (is => 'ro', isa => 'Paws::Batch::LogConfiguration', request_name => 'logConfiguration', traits => ['NameInRequest']);
15 has LogStreamName => (is => 'ro', isa => 'Str', request_name => 'logStreamName', traits => ['NameInRequest']);
16 has Memory => (is => 'ro', isa => 'Int', request_name => 'memory', traits => ['NameInRequest']);
17 has MountPoints => (is => 'ro', isa => 'ArrayRef[Paws::Batch::MountPoint]', request_name => 'mountPoints', traits => ['NameInRequest']);
18 has NetworkConfiguration => (is => 'ro', isa => 'Paws::Batch::NetworkConfiguration', request_name => 'networkConfiguration', traits => ['NameInRequest']);
19 has NetworkInterfaces => (is => 'ro', isa => 'ArrayRef[Paws::Batch::NetworkInterface]', request_name => 'networkInterfaces', traits => ['NameInRequest']);
20 has Privileged => (is => 'ro', isa => 'Bool', request_name => 'privileged', traits => ['NameInRequest']);
21 has ReadonlyRootFilesystem => (is => 'ro', isa => 'Bool', request_name => 'readonlyRootFilesystem', traits => ['NameInRequest']);
22 has Reason => (is => 'ro', isa => 'Str', request_name => 'reason', traits => ['NameInRequest']);
23 has ResourceRequirements => (is => 'ro', isa => 'ArrayRef[Paws::Batch::ResourceRequirement]', request_name => 'resourceRequirements', traits => ['NameInRequest']);
24 has Secrets => (is => 'ro', isa => 'ArrayRef[Paws::Batch::Secret]', request_name => 'secrets', traits => ['NameInRequest']);
25 has TaskArn => (is => 'ro', isa => 'Str', request_name => 'taskArn', traits => ['NameInRequest']);
26 has Ulimits => (is => 'ro', isa => 'ArrayRef[Paws::Batch::Ulimit]', request_name => 'ulimits', traits => ['NameInRequest']);
27 has User => (is => 'ro', isa => 'Str', request_name => 'user', traits => ['NameInRequest']);
28 has Vcpus => (is => 'ro', isa => 'Int', request_name => 'vcpus', traits => ['NameInRequest']);
29 has Volumes => (is => 'ro', isa => 'ArrayRef[Paws::Batch::Volume]', request_name => 'volumes', traits => ['NameInRequest']);
30  
31 1;
32  
33 ### main pod documentation begin ###
34  
35 =head1 NAME
36  
37 Paws::Batch::ContainerDetail
38  
39 =head1 USAGE
40  
41 This class represents one of two things:
42  
43 =head3 Arguments in a call to a service
44  
45 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
46 Each attribute should be used as a named argument in the calls that expect this type of object.
47  
48 As an example, if Att1 is expected to be a Paws::Batch::ContainerDetail object:
49  
50 $service_obj->Method(Att1 => { Command => $value, ..., Volumes => $value });
51  
52 =head3 Results returned from an API call
53  
54 Use accessors for each attribute. If Att1 is expected to be an Paws::Batch::ContainerDetail object:
55  
56 $result = $service_obj->Method(...);
57 $result->Att1->Command
58  
59 =head1 DESCRIPTION
60  
61 An object representing the details of a container that's part of a job.
62  
63 =head1 ATTRIBUTES
64  
65  
66 =head2 Command => ArrayRef[Str|Undef]
67  
68 The command that's passed to the container.
69  
70  
71 =head2 ContainerInstanceArn => Str
72  
73 The Amazon Resource Name (ARN) of the container instance that the
74 container is running on.
75  
76  
77 =head2 Environment => ArrayRef[L<Paws::Batch::KeyValuePair>]
78  
79 The environment variables to pass to a container.
80  
81 Environment variables must not start with C<AWS_BATCH>; this naming
82 convention is reserved for variables that are set by the AWS Batch
83 service.
84  
85  
86 =head2 ExecutionRoleArn => Str
87  
88 The Amazon Resource Name (ARN) of the execution role that AWS Batch can
89 assume. For more information, see AWS Batch execution IAM role
90 (https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html)
91 in the I<AWS Batch User Guide>.
92  
93  
94 =head2 ExitCode => Int
95  
96 The exit code to return upon completion.
97  
98  
99 =head2 FargatePlatformConfiguration => L<Paws::Batch::FargatePlatformConfiguration>
100  
101 The platform configuration for jobs running on Fargate resources. Jobs
102 running on EC2 resources must not specify this parameter.
103  
104  
105 =head2 Image => Str
106  
107 The image used to start the container.
108  
109  
110 =head2 InstanceType => Str
111  
112 The instance type of the underlying host infrastructure of a multi-node
113 parallel job.
114  
115 This parameter isn't applicable to jobs running on Fargate resources.
116  
117  
118 =head2 JobRoleArn => Str
119  
120 The Amazon Resource Name (ARN) associated with the job upon execution.
121  
122  
123 =head2 LinuxParameters => L<Paws::Batch::LinuxParameters>
124  
125 Linux-specific modifications that are applied to the container, such as
126 details for device mappings.
127  
128  
129 =head2 LogConfiguration => L<Paws::Batch::LogConfiguration>
130  
131 The log configuration specification for the container.
132  
133 This parameter maps to C<LogConfig> in the Create a container
134 (https://docs.docker.com/engine/api/v1.23/#create-a-container) section
135 of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
136 and the C<--log-driver> option to docker run
137 (https://docs.docker.com/engine/reference/run/). By default, containers
138 use the same logging driver that the Docker daemon uses. However, the
139 container might use a different logging driver than the Docker daemon
140 by specifying a log driver with this parameter in the container
141 definition. To use a different logging driver for a container, the log
142 system must be configured properly on the container instance. Or,
143 alternatively, it must be configured on a different log server for
144 remote logging options. For more information on the options for
145 different supported log drivers, see Configure logging drivers
146 (https://docs.docker.com/engine/admin/logging/overview/) in the Docker
147 documentation.
148  
149 AWS Batch currently supports a subset of the logging drivers available
150 to the Docker daemon (shown in the LogConfiguration data type).
151 Additional log drivers might be available in future releases of the
152 Amazon ECS container agent.
153  
154 This parameter requires version 1.18 of the Docker Remote API or
155 greater on your container instance. To check the Docker Remote API
156 version on your container instance, log into your container instance
157 and run the following command: C<sudo docker version | grep "Server API
158 version">
159  
160 The Amazon ECS container agent running on a container instance must
161 register the logging drivers available on that instance with the
162 C<ECS_AVAILABLE_LOGGING_DRIVERS> environment variable before containers
163 placed on that instance can use these log configuration options. For
164 more information, see Amazon ECS Container Agent Configuration
165 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)
166 in the I<Amazon Elastic Container Service Developer Guide>.
167  
168  
169 =head2 LogStreamName => Str
170  
171 The name of the CloudWatch Logs log stream associated with the
172 container. The log group for AWS Batch jobs is C</aws/batch/job>. Each
173 container attempt receives a log stream name when they reach the
174 C<RUNNING> status.
175  
176  
177 =head2 Memory => Int
178  
179 For jobs run on EC2 resources that didn't specify memory requirements
180 using C<ResourceRequirement>, the number of MiB of memory reserved for
181 the job. For other jobs, including all run on Fargate resources, see
182 C<resourceRequirements>.
183  
184  
185 =head2 MountPoints => ArrayRef[L<Paws::Batch::MountPoint>]
186  
187 The mount points for data volumes in your container.
188  
189  
190 =head2 NetworkConfiguration => L<Paws::Batch::NetworkConfiguration>
191  
192 The network configuration for jobs running on Fargate resources. Jobs
193 running on EC2 resources must not specify this parameter.
194  
195  
196 =head2 NetworkInterfaces => ArrayRef[L<Paws::Batch::NetworkInterface>]
197  
198 The network interfaces associated with the job.
199  
200  
201 =head2 Privileged => Bool
202  
203 When this parameter is true, the container is given elevated
204 permissions on the host container instance (similar to the C<root>
205 user). The default value is false.
206  
207 This parameter isn't applicable to jobs running on Fargate resources
208 and shouldn't be provided, or specified as false.
209  
210  
211 =head2 ReadonlyRootFilesystem => Bool
212  
213 When this parameter is true, the container is given read-only access to
214 its root file system. This parameter maps to C<ReadonlyRootfs> in the
215 Create a container
216 (https://docs.docker.com/engine/api/v1.23/#create-a-container) section
217 of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
218 and the C<--read-only> option to C<docker run>
219 (https://docs.docker.com/engine/reference/commandline/run/).
220  
221  
222 =head2 Reason => Str
223  
224 A short (255 max characters) human-readable string to provide
225 additional details about a running or stopped container.
226  
227  
228 =head2 ResourceRequirements => ArrayRef[L<Paws::Batch::ResourceRequirement>]
229  
230 The type and amount of resources to assign to a container. The
231 supported resources include C<GPU>, C<MEMORY>, and C<VCPU>.
232  
233  
234 =head2 Secrets => ArrayRef[L<Paws::Batch::Secret>]
235  
236 The secrets to pass to the container. For more information, see
237 Specifying sensitive data
238 (https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html)
239 in the I<AWS Batch User Guide>.
240  
241  
242 =head2 TaskArn => Str
243  
244 The Amazon Resource Name (ARN) of the Amazon ECS task that's associated
245 with the container job. Each container attempt receives a task ARN when
246 they reach the C<STARTING> status.
247  
248  
249 =head2 Ulimits => ArrayRef[L<Paws::Batch::Ulimit>]
250  
251 A list of C<ulimit> values to set in the container. This parameter maps
252 to C<Ulimits> in the Create a container
253 (https://docs.docker.com/engine/api/v1.23/#create-a-container) section
254 of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
255 and the C<--ulimit> option to docker run
256 (https://docs.docker.com/engine/reference/run/).
257  
258 This parameter isn't applicable to jobs running on Fargate resources.
259  
260  
261 =head2 User => Str
262  
263 The user name to use inside the container. This parameter maps to
264 C<User> in the Create a container
265 (https://docs.docker.com/engine/api/v1.23/#create-a-container) section
266 of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
267 and the C<--user> option to docker run
268 (https://docs.docker.com/engine/reference/run/).
269  
270  
271 =head2 Vcpus => Int
272  
273 The number of vCPUs reserved for the container. For jobs that run on
274 EC2 resources, you can specify the vCPU requirement for the job using
275 C<resourceRequirements>, but you can't specify the vCPU requirements in
276 both the C<vcpus> and C<resourceRequirement> object. This parameter
277 maps to C<CpuShares> in the Create a container
278 (https://docs.docker.com/engine/api/v1.23/#create-a-container) section
279 of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/)
280 and the C<--cpu-shares> option to docker run
281 (https://docs.docker.com/engine/reference/run/). Each vCPU is
282 equivalent to 1,024 CPU shares. You must specify at least one vCPU.
283 This is required but can be specified in several places. It must be
284 specified for each node at least once.
285  
286 This parameter isn't applicable to jobs that run on Fargate resources.
287 For jobs that run on Fargate resources, you must specify the vCPU
288 requirement for the job using C<resourceRequirements>.
289  
290  
291 =head2 Volumes => ArrayRef[L<Paws::Batch::Volume>]
292  
293 A list of volumes associated with the job.
294  
295  
296  
297 =head1 SEE ALSO
298  
299 This class forms part of L<Paws>, describing an object used in L<Paws::Batch>
300  
301 =head1 BUGS and CONTRIBUTIONS
302  
303 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
304  
305 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
306  
307 =cut
308