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

filter: Statementstmt 0.0% 0 / 22 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 24 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::AppStream::CreateImageBuilder;
3 use Moose;
4 has AccessEndpoints => (is => 'ro', isa => 'ArrayRef[Paws::AppStream::AccessEndpoint]');
5 has AppstreamAgentVersion => (is => 'ro', isa => 'Str');
6 has Description => (is => 'ro', isa => 'Str');
7 has DisplayName => (is => 'ro', isa => 'Str');
8 has DomainJoinInfo => (is => 'ro', isa => 'Paws::AppStream::DomainJoinInfo');
9 has EnableDefaultInternetAccess => (is => 'ro', isa => 'Bool');
10 has IamRoleArn => (is => 'ro', isa => 'Str');
11 has ImageArn => (is => 'ro', isa => 'Str');
12 has ImageName => (is => 'ro', isa => 'Str');
13 has InstanceType => (is => 'ro', isa => 'Str', required => 1);
14 has Name => (is => 'ro', isa => 'Str', required => 1);
15 has Tags => (is => 'ro', isa => 'Paws::AppStream::Tags');
16 has VpcConfig => (is => 'ro', isa => 'Paws::AppStream::VpcConfig');
17  
18 use MooseX::ClassAttribute;
19  
20 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateImageBuilder');
21 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppStream::CreateImageBuilderResult');
22 class_has _result_key => (isa => 'Str', is => 'ro');
23 1;
24  
25 ### main pod documentation begin ###
26  
27 =head1 NAME
28  
29 Paws::AppStream::CreateImageBuilder - Arguments for method CreateImageBuilder on L<Paws::AppStream>
30  
31 =head1 DESCRIPTION
32  
33 This class represents the parameters used for calling the method CreateImageBuilder on the
34 L<Amazon AppStream|Paws::AppStream> service. Use the attributes of this class
35 as arguments to method CreateImageBuilder.
36  
37 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateImageBuilder.
38  
39 =head1 SYNOPSIS
40  
41 my $appstream2 = Paws->service('AppStream');
42 my $CreateImageBuilderResult = $appstream2->CreateImageBuilder(
43 InstanceType => 'MyString',
44 Name => 'MyName',
45 AccessEndpoints => [
46 {
47 EndpointType => 'STREAMING', # values: STREAMING
48 VpceId => 'MyString', # min: 1
49 },
50 ...
51 ], # OPTIONAL
52 AppstreamAgentVersion => 'MyAppstreamAgentVersion', # OPTIONAL
53 Description => 'MyDescription', # OPTIONAL
54 DisplayName => 'MyDisplayName', # OPTIONAL
55 DomainJoinInfo => {
56 DirectoryName => 'MyDirectoryName', # OPTIONAL
57 OrganizationalUnitDistinguishedName =>
58 'MyOrganizationalUnitDistinguishedName', # max: 2000; OPTIONAL
59 }, # OPTIONAL
60 EnableDefaultInternetAccess => 1, # OPTIONAL
61 IamRoleArn => 'MyArn', # OPTIONAL
62 ImageArn => 'MyArn', # OPTIONAL
63 ImageName => 'MyString', # OPTIONAL
64 Tags => {
65 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256
66 }, # OPTIONAL
67 VpcConfig => {
68 SecurityGroupIds => [
69 'MyString', ... # min: 1
70 ], # max: 5; OPTIONAL
71 SubnetIds => [
72 'MyString', ... # min: 1
73 ], # OPTIONAL
74 }, # OPTIONAL
75 );
76  
77 # Results:
78 my $ImageBuilder = $CreateImageBuilderResult->ImageBuilder;
79  
80 # Returns a L<Paws::AppStream::CreateImageBuilderResult> object.
81  
82 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
83 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appstream2/CreateImageBuilder>
84  
85 =head1 ATTRIBUTES
86  
87  
88 =head2 AccessEndpoints => ArrayRef[L<Paws::AppStream::AccessEndpoint>]
89  
90 The list of interface VPC endpoint (interface endpoint) objects.
91 Administrators can connect to the image builder only through the
92 specified endpoints.
93  
94  
95  
96 =head2 AppstreamAgentVersion => Str
97  
98 The version of the AppStream 2.0 agent to use for this image builder.
99 To use the latest version of the AppStream 2.0 agent, specify [LATEST].
100  
101  
102  
103 =head2 Description => Str
104  
105 The description to display.
106  
107  
108  
109 =head2 DisplayName => Str
110  
111 The image builder name to display.
112  
113  
114  
115 =head2 DomainJoinInfo => L<Paws::AppStream::DomainJoinInfo>
116  
117 The name of the directory and organizational unit (OU) to use to join
118 the image builder to a Microsoft Active Directory domain.
119  
120  
121  
122 =head2 EnableDefaultInternetAccess => Bool
123  
124 Enables or disables default internet access for the image builder.
125  
126  
127  
128 =head2 IamRoleArn => Str
129  
130 The Amazon Resource Name (ARN) of the IAM role to apply to the image
131 builder. To assume a role, the image builder calls the AWS Security
132 Token Service (STS) C<AssumeRole> API operation and passes the ARN of
133 the role to use. The operation creates a new session with temporary
134 credentials. AppStream 2.0 retrieves the temporary credentials and
135 creates the B<appstream_machine_role> credential profile on the
136 instance.
137  
138 For more information, see Using an IAM Role to Grant Permissions to
139 Applications and Scripts Running on AppStream 2.0 Streaming Instances
140 (https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html)
141 in the I<Amazon AppStream 2.0 Administration Guide>.
142  
143  
144  
145 =head2 ImageArn => Str
146  
147 The ARN of the public, private, or shared image to use.
148  
149  
150  
151 =head2 ImageName => Str
152  
153 The name of the image used to create the image builder.
154  
155  
156  
157 =head2 B<REQUIRED> InstanceType => Str
158  
159 The instance type to use when launching the image builder. The
160 following instance types are available:
161  
162 =over
163  
164 =item *
165  
166 stream.standard.small
167  
168 =item *
169  
170 stream.standard.medium
171  
172 =item *
173  
174 stream.standard.large
175  
176 =item *
177  
178 stream.compute.large
179  
180 =item *
181  
182 stream.compute.xlarge
183  
184 =item *
185  
186 stream.compute.2xlarge
187  
188 =item *
189  
190 stream.compute.4xlarge
191  
192 =item *
193  
194 stream.compute.8xlarge
195  
196 =item *
197  
198 stream.memory.large
199  
200 =item *
201  
202 stream.memory.xlarge
203  
204 =item *
205  
206 stream.memory.2xlarge
207  
208 =item *
209  
210 stream.memory.4xlarge
211  
212 =item *
213  
214 stream.memory.8xlarge
215  
216 =item *
217  
218 stream.memory.z1d.large
219  
220 =item *
221  
222 stream.memory.z1d.xlarge
223  
224 =item *
225  
226 stream.memory.z1d.2xlarge
227  
228 =item *
229  
230 stream.memory.z1d.3xlarge
231  
232 =item *
233  
234 stream.memory.z1d.6xlarge
235  
236 =item *
237  
238 stream.memory.z1d.12xlarge
239  
240 =item *
241  
242 stream.graphics-design.large
243  
244 =item *
245  
246 stream.graphics-design.xlarge
247  
248 =item *
249  
250 stream.graphics-design.2xlarge
251  
252 =item *
253  
254 stream.graphics-design.4xlarge
255  
256 =item *
257  
258 stream.graphics-desktop.2xlarge
259  
260 =item *
261  
262 stream.graphics.g4dn.xlarge
263  
264 =item *
265  
266 stream.graphics.g4dn.2xlarge
267  
268 =item *
269  
270 stream.graphics.g4dn.4xlarge
271  
272 =item *
273  
274 stream.graphics.g4dn.8xlarge
275  
276 =item *
277  
278 stream.graphics.g4dn.12xlarge
279  
280 =item *
281  
282 stream.graphics.g4dn.16xlarge
283  
284 =item *
285  
286 stream.graphics-pro.4xlarge
287  
288 =item *
289  
290 stream.graphics-pro.8xlarge
291  
292 =item *
293  
294 stream.graphics-pro.16xlarge
295  
296 =back
297  
298  
299  
300  
301 =head2 B<REQUIRED> Name => Str
302  
303 A unique name for the image builder.
304  
305  
306  
307 =head2 Tags => L<Paws::AppStream::Tags>
308  
309 The tags to associate with the image builder. A tag is a key-value
310 pair, and the value is optional. For example, Environment=Test. If you
311 do not specify a value, Environment=.
312  
313 Generally allowed characters are: letters, numbers, and spaces
314 representable in UTF-8, and the following special characters:
315  
316 _ . : / = + \ - @
317  
318 If you do not specify a value, the value is set to an empty string.
319  
320 For more information about tags, see Tagging Your Resources
321 (https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html)
322 in the I<Amazon AppStream 2.0 Administration Guide>.
323  
324  
325  
326 =head2 VpcConfig => L<Paws::AppStream::VpcConfig>
327  
328 The VPC configuration for the image builder. You can specify only one
329 subnet.
330  
331  
332  
333  
334 =head1 SEE ALSO
335  
336 This class forms part of L<Paws>, documenting arguments for method CreateImageBuilder in L<Paws::AppStream>
337  
338 =head1 BUGS and CONTRIBUTIONS
339  
340 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
341  
342 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
343  
344 =cut
345