blib/lib/Paws/CloudFormation/UpdateStackSet.pm untested

filter: Statementstmt 0.0% 0 / 27 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 29 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CloudFormation::UpdateStackSet;
3 use Moose;
4 has Accounts => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5 has AdministrationRoleARN => (is => 'ro', isa => 'Str');
6 has AutoDeployment => (is => 'ro', isa => 'Paws::CloudFormation::AutoDeployment');
7 has CallAs => (is => 'ro', isa => 'Str');
8 has Capabilities => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9 has DeploymentTargets => (is => 'ro', isa => 'Paws::CloudFormation::DeploymentTargets');
10 has Description => (is => 'ro', isa => 'Str');
11 has ExecutionRoleName => (is => 'ro', isa => 'Str');
12 has OperationId => (is => 'ro', isa => 'Str');
13 has OperationPreferences => (is => 'ro', isa => 'Paws::CloudFormation::StackSetOperationPreferences');
14 has Parameters => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Parameter]');
15 has PermissionModel => (is => 'ro', isa => 'Str');
16 has Regions => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
17 has StackSetName => (is => 'ro', isa => 'Str', required => 1);
18 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Tag]');
19 has TemplateBody => (is => 'ro', isa => 'Str');
20 has TemplateURL => (is => 'ro', isa => 'Str');
21 has UsePreviousTemplate => (is => 'ro', isa => 'Bool');
22  
23 use MooseX::ClassAttribute;
24  
25 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateStackSet');
26 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::UpdateStackSetOutput');
27 class_has _result_key => (isa => 'Str', is => 'ro', default => 'UpdateStackSetResult');
28 1;
29  
30 ### main pod documentation begin ###
31  
32 =head1 NAME
33  
34 Paws::CloudFormation::UpdateStackSet - Arguments for method UpdateStackSet on L<Paws::CloudFormation>
35  
36 =head1 DESCRIPTION
37  
38 This class represents the parameters used for calling the method UpdateStackSet on the
39 L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class
40 as arguments to method UpdateStackSet.
41  
42 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateStackSet.
43  
44 =head1 SYNOPSIS
45  
46 my $cloudformation = Paws->service('CloudFormation');
47 my $UpdateStackSetOutput = $cloudformation->UpdateStackSet(
48 StackSetName => 'MyStackSetName',
49 Accounts => [ 'MyAccount', ... ], # OPTIONAL
50 AdministrationRoleARN => 'MyRoleARN', # OPTIONAL
51 AutoDeployment => {
52 Enabled => 1, # OPTIONAL
53 RetainStacksOnAccountRemoval => 1, # OPTIONAL
54 }, # OPTIONAL
55 CallAs => 'SELF', # OPTIONAL
56 Capabilities => [
57 'CAPABILITY_IAM',
58 ... # values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
59 ], # OPTIONAL
60 DeploymentTargets => {
61 Accounts => [ 'MyAccount', ... ],
62 AccountsUrl => 'MyAccountsUrl', # min: 1, max: 5120; OPTIONAL
63 OrganizationalUnitIds => [ 'MyOrganizationalUnitId', ... ], # OPTIONAL
64 }, # OPTIONAL
65 Description => 'MyDescription', # OPTIONAL
66 ExecutionRoleName => 'MyExecutionRoleName', # OPTIONAL
67 OperationId => 'MyClientRequestToken', # OPTIONAL
68 OperationPreferences => {
69 FailureToleranceCount => 1, # OPTIONAL
70 FailureTolerancePercentage => 1, # max: 100; OPTIONAL
71 MaxConcurrentCount => 1, # min: 1; OPTIONAL
72 MaxConcurrentPercentage => 1, # min: 1, max: 100; OPTIONAL
73 RegionConcurrencyType =>
74 'SEQUENTIAL', # values: SEQUENTIAL, PARALLEL; OPTIONAL
75 RegionOrder => [ 'MyRegion', ... ], # OPTIONAL
76 }, # OPTIONAL
77 Parameters => [
78 {
79 ParameterKey => 'MyParameterKey', # OPTIONAL
80 ParameterValue => 'MyParameterValue', # OPTIONAL
81 ResolvedValue => 'MyParameterValue', # OPTIONAL
82 UsePreviousValue => 1, # OPTIONAL
83 },
84 ...
85 ], # OPTIONAL
86 PermissionModel => 'SERVICE_MANAGED', # OPTIONAL
87 Regions => [ 'MyRegion', ... ], # OPTIONAL
88 Tags => [
89 {
90 Key => 'MyTagKey', # min: 1, max: 128
91 Value => 'MyTagValue', # min: 1, max: 256
92  
93 },
94 ...
95 ], # OPTIONAL
96 TemplateBody => 'MyTemplateBody', # OPTIONAL
97 TemplateURL => 'MyTemplateURL', # OPTIONAL
98 UsePreviousTemplate => 1, # OPTIONAL
99 );
100  
101 # Results:
102 my $OperationId = $UpdateStackSetOutput->OperationId;
103  
104 # Returns a L<Paws::CloudFormation::UpdateStackSetOutput> object.
105  
106 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.
107 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/UpdateStackSet>
108  
109 =head1 ATTRIBUTES
110  
111  
112 =head2 Accounts => ArrayRef[Str|Undef]
113  
114 [Self-managed permissions] The accounts in which to update associated
115 stack instances. If you specify accounts, you must also specify the
116 Regions in which to update stack set instances.
117  
118 To update I<all> the stack instances associated with this stack set, do
119 not specify the C<Accounts> or C<Regions> properties.
120  
121 If the stack set update includes changes to the template (that is, if
122 the C<TemplateBody> or C<TemplateURL> properties are specified), or the
123 C<Parameters> property, AWS CloudFormation marks all stack instances
124 with a status of C<OUTDATED> prior to updating the stack instances in
125 the specified accounts and Regions. If the stack set update does not
126 include changes to the template or parameters, AWS CloudFormation
127 updates the stack instances in the specified accounts and Regions,
128 while leaving all other stack instances with their existing stack
129 instance status.
130  
131  
132  
133 =head2 AdministrationRoleARN => Str
134  
135 The Amazon Resource Number (ARN) of the IAM role to use to update this
136 stack set.
137  
138 Specify an IAM role only if you are using customized administrator
139 roles to control which users or groups can manage specific stack sets
140 within the same administrator account. For more information, see
141 Granting Permissions for Stack Set Operations
142 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html)
143 in the I<AWS CloudFormation User Guide>.
144  
145 If you specified a customized administrator role when you created the
146 stack set, you must specify a customized administrator role, even if it
147 is the same customized administrator role used with this stack set
148 previously.
149  
150  
151  
152 =head2 AutoDeployment => L<Paws::CloudFormation::AutoDeployment>
153  
154 [Service-managed permissions] Describes whether StackSets automatically
155 deploys to AWS Organizations accounts that are added to a target
156 organization or organizational unit (OU).
157  
158 If you specify C<AutoDeployment>, do not specify C<DeploymentTargets>
159 or C<Regions>.
160  
161  
162  
163 =head2 CallAs => Str
164  
165 [Service-managed permissions] Specifies whether you are acting as an
166 account administrator in the organization's management account or as a
167 delegated administrator in a member account.
168  
169 By default, C<SELF> is specified. Use C<SELF> for stack sets with
170 self-managed permissions.
171  
172 =over
173  
174 =item *
175  
176 If you are signed in to the management account, specify C<SELF>.
177  
178 =item *
179  
180 If you are signed in to a delegated administrator account, specify
181 C<DELEGATED_ADMIN>.
182  
183 Your AWS account must be registered as a delegated administrator in the
184 management account. For more information, see Register a delegated
185 administrator
186 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
187 in the I<AWS CloudFormation User Guide>.
188  
189 =back
190  
191  
192 Valid values are: C<"SELF">, C<"DELEGATED_ADMIN">
193  
194 =head2 Capabilities => ArrayRef[Str|Undef]
195  
196 In some cases, you must explicitly acknowledge that your stack template
197 contains certain capabilities in order for AWS CloudFormation to update
198 the stack set and its associated stack instances.
199  
200 =over
201  
202 =item *
203  
204 C<CAPABILITY_IAM> and C<CAPABILITY_NAMED_IAM>
205  
206 Some stack templates might include resources that can affect
207 permissions in your AWS account; for example, by creating new AWS
208 Identity and Access Management (IAM) users. For those stacks sets, you
209 must explicitly acknowledge this by specifying one of these
210 capabilities.
211  
212 The following IAM resources require you to specify either the
213 C<CAPABILITY_IAM> or C<CAPABILITY_NAMED_IAM> capability.
214  
215 =over
216  
217 =item *
218  
219 If you have IAM resources, you can specify either capability.
220  
221 =item *
222  
223 If you have IAM resources with custom names, you I<must> specify
224 C<CAPABILITY_NAMED_IAM>.
225  
226 =item *
227  
228 If you don't specify either of these capabilities, AWS CloudFormation
229 returns an C<InsufficientCapabilities> error.
230  
231 =back
232  
233 If your stack template contains these resources, we recommend that you
234 review all permissions associated with them and edit their permissions
235 if necessary.
236  
237 =over
238  
239 =item *
240  
241 AWS::IAM::AccessKey
242 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
243  
244 =item *
245  
246 AWS::IAM::Group
247 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
248  
249 =item *
250  
251 AWS::IAM::InstanceProfile
252 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
253  
254 =item *
255  
256 AWS::IAM::Policy
257 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
258  
259 =item *
260  
261 AWS::IAM::Role
262 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
263  
264 =item *
265  
266 AWS::IAM::User
267 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
268  
269 =item *
270  
271 AWS::IAM::UserToGroupAddition
272 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
273  
274 =back
275  
276 For more information, see Acknowledging IAM Resources in AWS
277 CloudFormation Templates
278 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
279  
280 =item *
281  
282 C<CAPABILITY_AUTO_EXPAND>
283  
284 Some templates reference macros. If your stack set template references
285 one or more macros, you must update the stack set directly from the
286 processed template, without first reviewing the resulting changes in a
287 change set. To update the stack set directly, you must acknowledge this
288 capability. For more information, see Using AWS CloudFormation Macros
289 to Perform Custom Processing on Templates
290 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
291  
292 Stack sets with service-managed permissions do not currently support
293 the use of macros in templates. (This includes the AWS::Include
294 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html)
295 and AWS::Serverless
296 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html)
297 transforms, which are macros hosted by AWS CloudFormation.) Even if you
298 specify this capability for a stack set with service-managed
299 permissions, if you reference a macro in your template the stack set
300 operation will fail.
301  
302 =back
303  
304  
305  
306  
307 =head2 DeploymentTargets => L<Paws::CloudFormation::DeploymentTargets>
308  
309 [Service-managed permissions] The AWS Organizations accounts in which
310 to update associated stack instances.
311  
312 To update all the stack instances associated with this stack set, do
313 not specify C<DeploymentTargets> or C<Regions>.
314  
315 If the stack set update includes changes to the template (that is, if
316 C<TemplateBody> or C<TemplateURL> is specified), or the C<Parameters>,
317 AWS CloudFormation marks all stack instances with a status of
318 C<OUTDATED> prior to updating the stack instances in the specified
319 accounts and Regions. If the stack set update does not include changes
320 to the template or parameters, AWS CloudFormation updates the stack
321 instances in the specified accounts and Regions, while leaving all
322 other stack instances with their existing stack instance status.
323  
324  
325  
326 =head2 Description => Str
327  
328 A brief description of updates that you are making.
329  
330  
331  
332 =head2 ExecutionRoleName => Str
333  
334 The name of the IAM execution role to use to update the stack set. If
335 you do not specify an execution role, AWS CloudFormation uses the
336 C<AWSCloudFormationStackSetExecutionRole> role for the stack set
337 operation.
338  
339 Specify an IAM role only if you are using customized execution roles to
340 control which stack resources users and groups can include in their
341 stack sets.
342  
343 If you specify a customized execution role, AWS CloudFormation uses
344 that role to update the stack. If you do not specify a customized
345 execution role, AWS CloudFormation performs the update using the role
346 previously associated with the stack set, so long as you have
347 permissions to perform operations on the stack set.
348  
349  
350  
351 =head2 OperationId => Str
352  
353 The unique ID for this stack set operation.
354  
355 The operation ID also functions as an idempotency token, to ensure that
356 AWS CloudFormation performs the stack set operation only once, even if
357 you retry the request multiple times. You might retry stack set
358 operation requests to ensure that AWS CloudFormation successfully
359 received them.
360  
361 If you don't specify an operation ID, AWS CloudFormation generates one
362 automatically.
363  
364 Repeating this stack set operation with a new operation ID retries all
365 stack instances whose status is C<OUTDATED>.
366  
367  
368  
369 =head2 OperationPreferences => L<Paws::CloudFormation::StackSetOperationPreferences>
370  
371 Preferences for how AWS CloudFormation performs this stack set
372 operation.
373  
374  
375  
376 =head2 Parameters => ArrayRef[L<Paws::CloudFormation::Parameter>]
377  
378 A list of input parameters for the stack set template.
379  
380  
381  
382 =head2 PermissionModel => Str
383  
384 Describes how the IAM roles required for stack set operations are
385 created. You cannot modify C<PermissionModel> if there are stack
386 instances associated with your stack set.
387  
388 =over
389  
390 =item *
391  
392 With C<self-managed> permissions, you must create the administrator and
393 execution roles required to deploy to target accounts. For more
394 information, see Grant Self-Managed Stack Set Permissions
395 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html).
396  
397 =item *
398  
399 With C<service-managed> permissions, StackSets automatically creates
400 the IAM roles required to deploy to accounts managed by AWS
401 Organizations. For more information, see Grant Service-Managed Stack
402 Set Permissions
403 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html).
404  
405 =back
406  
407  
408 Valid values are: C<"SERVICE_MANAGED">, C<"SELF_MANAGED">
409  
410 =head2 Regions => ArrayRef[Str|Undef]
411  
412 The Regions in which to update associated stack instances. If you
413 specify Regions, you must also specify accounts in which to update
414 stack set instances.
415  
416 To update I<all> the stack instances associated with this stack set, do
417 not specify the C<Accounts> or C<Regions> properties.
418  
419 If the stack set update includes changes to the template (that is, if
420 the C<TemplateBody> or C<TemplateURL> properties are specified), or the
421 C<Parameters> property, AWS CloudFormation marks all stack instances
422 with a status of C<OUTDATED> prior to updating the stack instances in
423 the specified accounts and Regions. If the stack set update does not
424 include changes to the template or parameters, AWS CloudFormation
425 updates the stack instances in the specified accounts and Regions,
426 while leaving all other stack instances with their existing stack
427 instance status.
428  
429  
430  
431 =head2 B<REQUIRED> StackSetName => Str
432  
433 The name or unique ID of the stack set that you want to update.
434  
435  
436  
437 =head2 Tags => ArrayRef[L<Paws::CloudFormation::Tag>]
438  
439 The key-value pairs to associate with this stack set and the stacks
440 created from it. AWS CloudFormation also propagates these tags to
441 supported resources that are created in the stacks. You can specify a
442 maximum number of 50 tags.
443  
444 If you specify tags for this parameter, those tags replace any list of
445 tags that are currently associated with this stack set. This means:
446  
447 =over
448  
449 =item *
450  
451 If you don't specify this parameter, AWS CloudFormation doesn't modify
452 the stack's tags.
453  
454 =item *
455  
456 If you specify I<any> tags using this parameter, you must specify
457 I<all> the tags that you want associated with this stack set, even tags
458 you've specifed before (for example, when creating the stack set or
459 during a previous update of the stack set.). Any tags that you don't
460 include in the updated list of tags are removed from the stack set, and
461 therefore from the stacks and resources as well.
462  
463 =item *
464  
465 If you specify an empty value, AWS CloudFormation removes all currently
466 associated tags.
467  
468 =back
469  
470 If you specify new tags as part of an C<UpdateStackSet> action, AWS
471 CloudFormation checks to see if you have the required IAM permission to
472 tag resources. If you omit tags that are currently associated with the
473 stack set from the list of tags you specify, AWS CloudFormation assumes
474 that you want to remove those tags from the stack set, and checks to
475 see if you have permission to untag resources. If you don't have the
476 necessary permission(s), the entire C<UpdateStackSet> action fails with
477 an C<access denied> error, and the stack set is not updated.
478  
479  
480  
481 =head2 TemplateBody => Str
482  
483 The structure that contains the template body, with a minimum length of
484 1 byte and a maximum length of 51,200 bytes. For more information, see
485 Template Anatomy
486 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
487 in the AWS CloudFormation User Guide.
488  
489 Conditional: You must specify only one of the following parameters:
490 C<TemplateBody> or C<TemplateURL>E<mdash>or set C<UsePreviousTemplate>
491 to true.
492  
493  
494  
495 =head2 TemplateURL => Str
496  
497 The location of the file that contains the template body. The URL must
498 point to a template (maximum size: 460,800 bytes) that is located in an
499 Amazon S3 bucket or a Systems Manager document. For more information,
500 see Template Anatomy
501 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
502 in the AWS CloudFormation User Guide.
503  
504 Conditional: You must specify only one of the following parameters:
505 C<TemplateBody> or C<TemplateURL>E<mdash>or set C<UsePreviousTemplate>
506 to true.
507  
508  
509  
510 =head2 UsePreviousTemplate => Bool
511  
512 Use the existing template that's associated with the stack set that
513 you're updating.
514  
515 Conditional: You must specify only one of the following parameters:
516 C<TemplateBody> or C<TemplateURL>E<mdash>or set C<UsePreviousTemplate>
517 to true.
518  
519  
520  
521  
522 =head1 SEE ALSO
523  
524 This class forms part of L<Paws>, documenting arguments for method UpdateStackSet in L<Paws::CloudFormation>
525  
526 =head1 BUGS and CONTRIBUTIONS
527  
528 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
529  
530 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
531  
532 =cut
533