blib/lib/Paws/CloudFormation/CreateStackSet.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::CloudFormation::CreateStackSet;
3 use Moose;
4 has AdministrationRoleARN => (is => 'ro', isa => 'Str');
5 has AutoDeployment => (is => 'ro', isa => 'Paws::CloudFormation::AutoDeployment');
6 has CallAs => (is => 'ro', isa => 'Str');
7 has Capabilities => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8 has ClientRequestToken => (is => 'ro', isa => 'Str');
9 has Description => (is => 'ro', isa => 'Str');
10 has ExecutionRoleName => (is => 'ro', isa => 'Str');
11 has Parameters => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Parameter]');
12 has PermissionModel => (is => 'ro', isa => 'Str');
13 has StackSetName => (is => 'ro', isa => 'Str', required => 1);
14 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Tag]');
15 has TemplateBody => (is => 'ro', isa => 'Str');
16 has TemplateURL => (is => 'ro', isa => 'Str');
17  
18 use MooseX::ClassAttribute;
19  
20 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateStackSet');
21 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::CreateStackSetOutput');
22 class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateStackSetResult');
23 1;
24  
25 ### main pod documentation begin ###
26  
27 =head1 NAME
28  
29 Paws::CloudFormation::CreateStackSet - Arguments for method CreateStackSet on L<Paws::CloudFormation>
30  
31 =head1 DESCRIPTION
32  
33 This class represents the parameters used for calling the method CreateStackSet on the
34 L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class
35 as arguments to method CreateStackSet.
36  
37 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateStackSet.
38  
39 =head1 SYNOPSIS
40  
41 my $cloudformation = Paws->service('CloudFormation');
42 my $CreateStackSetOutput = $cloudformation->CreateStackSet(
43 StackSetName => 'MyStackSetName',
44 AdministrationRoleARN => 'MyRoleARN', # OPTIONAL
45 AutoDeployment => {
46 Enabled => 1, # OPTIONAL
47 RetainStacksOnAccountRemoval => 1, # OPTIONAL
48 }, # OPTIONAL
49 CallAs => 'SELF', # OPTIONAL
50 Capabilities => [
51 'CAPABILITY_IAM',
52 ... # values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND
53 ], # OPTIONAL
54 ClientRequestToken => 'MyClientRequestToken', # OPTIONAL
55 Description => 'MyDescription', # OPTIONAL
56 ExecutionRoleName => 'MyExecutionRoleName', # OPTIONAL
57 Parameters => [
58 {
59 ParameterKey => 'MyParameterKey', # OPTIONAL
60 ParameterValue => 'MyParameterValue', # OPTIONAL
61 ResolvedValue => 'MyParameterValue', # OPTIONAL
62 UsePreviousValue => 1, # OPTIONAL
63 },
64 ...
65 ], # OPTIONAL
66 PermissionModel => 'SERVICE_MANAGED', # OPTIONAL
67 Tags => [
68 {
69 Key => 'MyTagKey', # min: 1, max: 128
70 Value => 'MyTagValue', # min: 1, max: 256
71  
72 },
73 ...
74 ], # OPTIONAL
75 TemplateBody => 'MyTemplateBody', # OPTIONAL
76 TemplateURL => 'MyTemplateURL', # OPTIONAL
77 );
78  
79 # Results:
80 my $StackSetId = $CreateStackSetOutput->StackSetId;
81  
82 # Returns a L<Paws::CloudFormation::CreateStackSetOutput> object.
83  
84 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.
85 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/CreateStackSet>
86  
87 =head1 ATTRIBUTES
88  
89  
90 =head2 AdministrationRoleARN => Str
91  
92 The Amazon Resource Number (ARN) of the IAM role to use to create this
93 stack set.
94  
95 Specify an IAM role only if you are using customized administrator
96 roles to control which users or groups can manage specific stack sets
97 within the same administrator account. For more information, see
98 Prerequisites: Granting Permissions for Stack Set Operations
99 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html)
100 in the I<AWS CloudFormation User Guide>.
101  
102  
103  
104 =head2 AutoDeployment => L<Paws::CloudFormation::AutoDeployment>
105  
106 Describes whether StackSets automatically deploys to AWS Organizations
107 accounts that are added to the target organization or organizational
108 unit (OU). Specify only if C<PermissionModel> is C<SERVICE_MANAGED>.
109  
110  
111  
112 =head2 CallAs => Str
113  
114 [Service-managed permissions] Specifies whether you are acting as an
115 account administrator in the organization's management account or as a
116 delegated administrator in a member account.
117  
118 By default, C<SELF> is specified. Use C<SELF> for stack sets with
119 self-managed permissions.
120  
121 =over
122  
123 =item *
124  
125 To create a stack set with service-managed permissions while signed in
126 to the management account, specify C<SELF>.
127  
128 =item *
129  
130 To create a stack set with service-managed permissions while signed in
131 to a delegated administrator account, specify C<DELEGATED_ADMIN>.
132  
133 Your AWS account must be registered as a delegated admin in the
134 management account. For more information, see Register a delegated
135 administrator
136 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
137 in the I<AWS CloudFormation User Guide>.
138  
139 =back
140  
141 Stack sets with service-managed permissions are created in the
142 management account, including stack sets that are created by delegated
143 administrators.
144  
145 Valid values are: C<"SELF">, C<"DELEGATED_ADMIN">
146  
147 =head2 Capabilities => ArrayRef[Str|Undef]
148  
149 In some cases, you must explicitly acknowledge that your stack set
150 template contains certain capabilities in order for AWS CloudFormation
151 to create the stack set and related stack instances.
152  
153 =over
154  
155 =item *
156  
157 C<CAPABILITY_IAM> and C<CAPABILITY_NAMED_IAM>
158  
159 Some stack templates might include resources that can affect
160 permissions in your AWS account; for example, by creating new AWS
161 Identity and Access Management (IAM) users. For those stack sets, you
162 must explicitly acknowledge this by specifying one of these
163 capabilities.
164  
165 The following IAM resources require you to specify either the
166 C<CAPABILITY_IAM> or C<CAPABILITY_NAMED_IAM> capability.
167  
168 =over
169  
170 =item *
171  
172 If you have IAM resources, you can specify either capability.
173  
174 =item *
175  
176 If you have IAM resources with custom names, you I<must> specify
177 C<CAPABILITY_NAMED_IAM>.
178  
179 =item *
180  
181 If you don't specify either of these capabilities, AWS CloudFormation
182 returns an C<InsufficientCapabilities> error.
183  
184 =back
185  
186 If your stack template contains these resources, we recommend that you
187 review all permissions associated with them and edit their permissions
188 if necessary.
189  
190 =over
191  
192 =item *
193  
194 AWS::IAM::AccessKey
195 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html)
196  
197 =item *
198  
199 AWS::IAM::Group
200 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html)
201  
202 =item *
203  
204 AWS::IAM::InstanceProfile
205 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html)
206  
207 =item *
208  
209 AWS::IAM::Policy
210 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html)
211  
212 =item *
213  
214 AWS::IAM::Role
215 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html)
216  
217 =item *
218  
219 AWS::IAM::User
220 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html)
221  
222 =item *
223  
224 AWS::IAM::UserToGroupAddition
225 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html)
226  
227 =back
228  
229 For more information, see Acknowledging IAM Resources in AWS
230 CloudFormation Templates
231 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities).
232  
233 =item *
234  
235 C<CAPABILITY_AUTO_EXPAND>
236  
237 Some templates reference macros. If your stack set template references
238 one or more macros, you must create the stack set directly from the
239 processed template, without first reviewing the resulting changes in a
240 change set. To create the stack set directly, you must acknowledge this
241 capability. For more information, see Using AWS CloudFormation Macros
242 to Perform Custom Processing on Templates
243 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html).
244  
245 Stack sets with service-managed permissions do not currently support
246 the use of macros in templates. (This includes the AWS::Include
247 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html)
248 and AWS::Serverless
249 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html)
250 transforms, which are macros hosted by AWS CloudFormation.) Even if you
251 specify this capability for a stack set with service-managed
252 permissions, if you reference a macro in your template the stack set
253 operation will fail.
254  
255 =back
256  
257  
258  
259  
260 =head2 ClientRequestToken => Str
261  
262 A unique identifier for this C<CreateStackSet> request. Specify this
263 token if you plan to retry requests so that AWS CloudFormation knows
264 that you're not attempting to create another stack set with the same
265 name. You might retry C<CreateStackSet> requests to ensure that AWS
266 CloudFormation successfully received them.
267  
268 If you don't specify an operation ID, the SDK generates one
269 automatically.
270  
271  
272  
273 =head2 Description => Str
274  
275 A description of the stack set. You can use the description to identify
276 the stack set's purpose or other important information.
277  
278  
279  
280 =head2 ExecutionRoleName => Str
281  
282 The name of the IAM execution role to use to create the stack set. If
283 you do not specify an execution role, AWS CloudFormation uses the
284 C<AWSCloudFormationStackSetExecutionRole> role for the stack set
285 operation.
286  
287 Specify an IAM role only if you are using customized execution roles to
288 control which stack resources users and groups can include in their
289 stack sets.
290  
291  
292  
293 =head2 Parameters => ArrayRef[L<Paws::CloudFormation::Parameter>]
294  
295 The input parameters for the stack set template.
296  
297  
298  
299 =head2 PermissionModel => Str
300  
301 Describes how the IAM roles required for stack set operations are
302 created. By default, C<SELF-MANAGED> is specified.
303  
304 =over
305  
306 =item *
307  
308 With C<self-managed> permissions, you must create the administrator and
309 execution roles required to deploy to target accounts. For more
310 information, see Grant Self-Managed Stack Set Permissions
311 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html).
312  
313 =item *
314  
315 With C<service-managed> permissions, StackSets automatically creates
316 the IAM roles required to deploy to accounts managed by AWS
317 Organizations. For more information, see Grant Service-Managed Stack
318 Set Permissions
319 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-service-managed.html).
320  
321 =back
322  
323  
324 Valid values are: C<"SERVICE_MANAGED">, C<"SELF_MANAGED">
325  
326 =head2 B<REQUIRED> StackSetName => Str
327  
328 The name to associate with the stack set. The name must be unique in
329 the Region where you create your stack set.
330  
331 A stack name can contain only alphanumeric characters (case-sensitive)
332 and hyphens. It must start with an alphabetic character and can't be
333 longer than 128 characters.
334  
335  
336  
337 =head2 Tags => ArrayRef[L<Paws::CloudFormation::Tag>]
338  
339 The key-value pairs to associate with this stack set and the stacks
340 created from it. AWS CloudFormation also propagates these tags to
341 supported resources that are created in the stacks. A maximum number of
342 50 tags can be specified.
343  
344 If you specify tags as part of a C<CreateStackSet> action, AWS
345 CloudFormation checks to see if you have the required IAM permission to
346 tag resources. If you don't, the entire C<CreateStackSet> action fails
347 with an C<access denied> error, and the stack set is not created.
348  
349  
350  
351 =head2 TemplateBody => Str
352  
353 The structure that contains the template body, with a minimum length of
354 1 byte and a maximum length of 51,200 bytes. For more information, see
355 Template Anatomy
356 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
357 in the AWS CloudFormation User Guide.
358  
359 Conditional: You must specify either the TemplateBody or the
360 TemplateURL parameter, but not both.
361  
362  
363  
364 =head2 TemplateURL => Str
365  
366 The location of the file that contains the template body. The URL must
367 point to a template (maximum size: 460,800 bytes) that's located in an
368 Amazon S3 bucket or a Systems Manager document. For more information,
369 see Template Anatomy
370 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
371 in the AWS CloudFormation User Guide.
372  
373 Conditional: You must specify either the TemplateBody or the
374 TemplateURL parameter, but not both.
375  
376  
377  
378  
379 =head1 SEE ALSO
380  
381 This class forms part of L<Paws>, documenting arguments for method CreateStackSet in L<Paws::CloudFormation>
382  
383 =head1 BUGS and CONTRIBUTIONS
384  
385 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
386  
387 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
388  
389 =cut
390