blib/lib/Paws/AppStream/Fleet.pm untested

filter: Statementstmt 0.0% 0 / 23 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 24 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::AppStream::Fleet;
3 use Moose;
4 has Arn => (is => 'ro', isa => 'Str', required => 1);
5 has ComputeCapacityStatus => (is => 'ro', isa => 'Paws::AppStream::ComputeCapacityStatus', required => 1);
6 has CreatedTime => (is => 'ro', isa => 'Str');
7 has Description => (is => 'ro', isa => 'Str');
8 has DisconnectTimeoutInSeconds => (is => 'ro', isa => 'Int');
9 has DisplayName => (is => 'ro', isa => 'Str');
10 has DomainJoinInfo => (is => 'ro', isa => 'Paws::AppStream::DomainJoinInfo');
11 has EnableDefaultInternetAccess => (is => 'ro', isa => 'Bool');
12 has FleetErrors => (is => 'ro', isa => 'ArrayRef[Paws::AppStream::FleetError]');
13 has FleetType => (is => 'ro', isa => 'Str');
14 has IamRoleArn => (is => 'ro', isa => 'Str');
15 has IdleDisconnectTimeoutInSeconds => (is => 'ro', isa => 'Int');
16 has ImageArn => (is => 'ro', isa => 'Str');
17 has ImageName => (is => 'ro', isa => 'Str');
18 has InstanceType => (is => 'ro', isa => 'Str', required => 1);
19 has MaxUserDurationInSeconds => (is => 'ro', isa => 'Int');
20 has Name => (is => 'ro', isa => 'Str', required => 1);
21 has State => (is => 'ro', isa => 'Str', required => 1);
22 has StreamView => (is => 'ro', isa => 'Str');
23 has VpcConfig => (is => 'ro', isa => 'Paws::AppStream::VpcConfig');
24  
25 1;
26  
27 ### main pod documentation begin ###
28  
29 =head1 NAME
30  
31 Paws::AppStream::Fleet
32  
33 =head1 USAGE
34  
35 This class represents one of two things:
36  
37 =head3 Arguments in a call to a service
38  
39 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
40 Each attribute should be used as a named argument in the calls that expect this type of object.
41  
42 As an example, if Att1 is expected to be a Paws::AppStream::Fleet object:
43  
44 $service_obj->Method(Att1 => { Arn => $value, ..., VpcConfig => $value });
45  
46 =head3 Results returned from an API call
47  
48 Use accessors for each attribute. If Att1 is expected to be an Paws::AppStream::Fleet object:
49  
50 $result = $service_obj->Method(...);
51 $result->Att1->Arn
52  
53 =head1 DESCRIPTION
54  
55 Describes a fleet.
56  
57 =head1 ATTRIBUTES
58  
59  
60 =head2 B<REQUIRED> Arn => Str
61  
62 The Amazon Resource Name (ARN) for the fleet.
63  
64  
65 =head2 B<REQUIRED> ComputeCapacityStatus => L<Paws::AppStream::ComputeCapacityStatus>
66  
67 The capacity status for the fleet.
68  
69  
70 =head2 CreatedTime => Str
71  
72 The time the fleet was created.
73  
74  
75 =head2 Description => Str
76  
77 The description to display.
78  
79  
80 =head2 DisconnectTimeoutInSeconds => Int
81  
82 The amount of time that a streaming session remains active after users
83 disconnect. If they try to reconnect to the streaming session after a
84 disconnection or network interruption within this time interval, they
85 are connected to their previous session. Otherwise, they are connected
86 to a new session with a new streaming instance.
87  
88 Specify a value between 60 and 360000.
89  
90  
91 =head2 DisplayName => Str
92  
93 The fleet name to display.
94  
95  
96 =head2 DomainJoinInfo => L<Paws::AppStream::DomainJoinInfo>
97  
98 The name of the directory and organizational unit (OU) to use to join
99 the fleet to a Microsoft Active Directory domain.
100  
101  
102 =head2 EnableDefaultInternetAccess => Bool
103  
104 Indicates whether default internet access is enabled for the fleet.
105  
106  
107 =head2 FleetErrors => ArrayRef[L<Paws::AppStream::FleetError>]
108  
109 The fleet errors.
110  
111  
112 =head2 FleetType => Str
113  
114 The fleet type.
115  
116 =over
117  
118 =item ALWAYS_ON
119  
120 Provides users with instant-on access to their apps. You are charged
121 for all running instances in your fleet, even if no users are streaming
122 apps.
123  
124 =item ON_DEMAND
125  
126 Provide users with access to applications after they connect, which
127 takes one to two minutes. You are charged for instance streaming when
128 users are connected and a small hourly fee for instances that are not
129 streaming apps.
130  
131 =back
132  
133  
134  
135 =head2 IamRoleArn => Str
136  
137 The ARN of the IAM role that is applied to the fleet. To assume a role,
138 the fleet instance calls the AWS Security Token Service (STS)
139 C<AssumeRole> API operation and passes the ARN of the role to use. The
140 operation creates a new session with temporary credentials. AppStream
141 2.0 retrieves the temporary credentials and creates the
142 B<appstream_machine_role> credential profile on the instance.
143  
144 For more information, see Using an IAM Role to Grant Permissions to
145 Applications and Scripts Running on AppStream 2.0 Streaming Instances
146 (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html)
147 in the I<Amazon AppStream 2.0 Administration Guide>.
148  
149  
150 =head2 IdleDisconnectTimeoutInSeconds => Int
151  
152 The amount of time that users can be idle (inactive) before they are
153 disconnected from their streaming session and the
154 C<DisconnectTimeoutInSeconds> time interval begins. Users are notified
155 before they are disconnected due to inactivity. If users try to
156 reconnect to the streaming session before the time interval specified
157 in C<DisconnectTimeoutInSeconds> elapses, they are connected to their
158 previous session. Users are considered idle when they stop providing
159 keyboard or mouse input during their streaming session. File uploads
160 and downloads, audio in, audio out, and pixels changing do not qualify
161 as user activity. If users continue to be idle after the time interval
162 in C<IdleDisconnectTimeoutInSeconds> elapses, they are disconnected.
163  
164 To prevent users from being disconnected due to inactivity, specify a
165 value of 0. Otherwise, specify a value between 60 and 3600. The default
166 value is 0.
167  
168 If you enable this feature, we recommend that you specify a value that
169 corresponds exactly to a whole number of minutes (for example, 60, 120,
170 and 180). If you don't do this, the value is rounded to the nearest
171 minute. For example, if you specify a value of 70, users are
172 disconnected after 1 minute of inactivity. If you specify a value that
173 is at the midpoint between two different minutes, the value is rounded
174 up. For example, if you specify a value of 90, users are disconnected
175 after 2 minutes of inactivity.
176  
177  
178 =head2 ImageArn => Str
179  
180 The ARN for the public, private, or shared image.
181  
182  
183 =head2 ImageName => Str
184  
185 The name of the image used to create the fleet.
186  
187  
188 =head2 B<REQUIRED> InstanceType => Str
189  
190 The instance type to use when launching fleet instances. The following
191 instance types are available:
192  
193 =over
194  
195 =item *
196  
197 stream.standard.small
198  
199 =item *
200  
201 stream.standard.medium
202  
203 =item *
204  
205 stream.standard.large
206  
207 =item *
208  
209 stream.compute.large
210  
211 =item *
212  
213 stream.compute.xlarge
214  
215 =item *
216  
217 stream.compute.2xlarge
218  
219 =item *
220  
221 stream.compute.4xlarge
222  
223 =item *
224  
225 stream.compute.8xlarge
226  
227 =item *
228  
229 stream.memory.large
230  
231 =item *
232  
233 stream.memory.xlarge
234  
235 =item *
236  
237 stream.memory.2xlarge
238  
239 =item *
240  
241 stream.memory.4xlarge
242  
243 =item *
244  
245 stream.memory.8xlarge
246  
247 =item *
248  
249 stream.memory.z1d.large
250  
251 =item *
252  
253 stream.memory.z1d.xlarge
254  
255 =item *
256  
257 stream.memory.z1d.2xlarge
258  
259 =item *
260  
261 stream.memory.z1d.3xlarge
262  
263 =item *
264  
265 stream.memory.z1d.6xlarge
266  
267 =item *
268  
269 stream.memory.z1d.12xlarge
270  
271 =item *
272  
273 stream.graphics-design.large
274  
275 =item *
276  
277 stream.graphics-design.xlarge
278  
279 =item *
280  
281 stream.graphics-design.2xlarge
282  
283 =item *
284  
285 stream.graphics-design.4xlarge
286  
287 =item *
288  
289 stream.graphics-desktop.2xlarge
290  
291 =item *
292  
293 stream.graphics.g4dn.xlarge
294  
295 =item *
296  
297 stream.graphics.g4dn.2xlarge
298  
299 =item *
300  
301 stream.graphics.g4dn.4xlarge
302  
303 =item *
304  
305 stream.graphics.g4dn.8xlarge
306  
307 =item *
308  
309 stream.graphics.g4dn.12xlarge
310  
311 =item *
312  
313 stream.graphics.g4dn.16xlarge
314  
315 =item *
316  
317 stream.graphics-pro.4xlarge
318  
319 =item *
320  
321 stream.graphics-pro.8xlarge
322  
323 =item *
324  
325 stream.graphics-pro.16xlarge
326  
327 =back
328  
329  
330  
331 =head2 MaxUserDurationInSeconds => Int
332  
333 The maximum amount of time that a streaming session can remain active,
334 in seconds. If users are still connected to a streaming instance five
335 minutes before this limit is reached, they are prompted to save any
336 open documents before being disconnected. After this time elapses, the
337 instance is terminated and replaced by a new instance.
338  
339 Specify a value between 600 and 360000.
340  
341  
342 =head2 B<REQUIRED> Name => Str
343  
344 The name of the fleet.
345  
346  
347 =head2 B<REQUIRED> State => Str
348  
349 The current state for the fleet.
350  
351  
352 =head2 StreamView => Str
353  
354 The AppStream 2.0 view that is displayed to your users when they stream
355 from the fleet. When C<APP> is specified, only the windows of
356 applications opened by users display. When C<DESKTOP> is specified, the
357 standard desktop that is provided by the operating system displays.
358  
359 The default value is C<APP>.
360  
361  
362 =head2 VpcConfig => L<Paws::AppStream::VpcConfig>
363  
364 The VPC configuration for the fleet.
365  
366  
367  
368 =head1 SEE ALSO
369  
370 This class forms part of L<Paws>, describing an object used in L<Paws::AppStream>
371  
372 =head1 BUGS and CONTRIBUTIONS
373  
374 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
375  
376 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
377  
378 =cut
379