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

filter: Statementstmt 0.0% 0 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CloudFormation::CreateStackInstances;
3 use Moose;
4 has Accounts => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5 has CallAs => (is => 'ro', isa => 'Str');
6 has DeploymentTargets => (is => 'ro', isa => 'Paws::CloudFormation::DeploymentTargets');
7 has OperationId => (is => 'ro', isa => 'Str');
8 has OperationPreferences => (is => 'ro', isa => 'Paws::CloudFormation::StackSetOperationPreferences');
9 has ParameterOverrides => (is => 'ro', isa => 'ArrayRef[Paws::CloudFormation::Parameter]');
10 has Regions => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
11 has StackSetName => (is => 'ro', isa => 'Str', required => 1);
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateStackInstances');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::CreateStackInstancesOutput');
17 class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateStackInstancesResult');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::CloudFormation::CreateStackInstances - Arguments for method CreateStackInstances on L<Paws::CloudFormation>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method CreateStackInstances on the
29 L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class
30 as arguments to method CreateStackInstances.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateStackInstances.
33  
34 =head1 SYNOPSIS
35  
36 my $cloudformation = Paws->service('CloudFormation');
37 my $CreateStackInstancesOutput = $cloudformation->CreateStackInstances(
38 Regions => [ 'MyRegion', ... ],
39 StackSetName => 'MyStackSetName',
40 Accounts => [ 'MyAccount', ... ], # OPTIONAL
41 CallAs => 'SELF', # OPTIONAL
42 DeploymentTargets => {
43 Accounts => [ 'MyAccount', ... ],
44 AccountsUrl => 'MyAccountsUrl', # min: 1, max: 5120; OPTIONAL
45 OrganizationalUnitIds => [ 'MyOrganizationalUnitId', ... ], # OPTIONAL
46 }, # OPTIONAL
47 OperationId => 'MyClientRequestToken', # OPTIONAL
48 OperationPreferences => {
49 FailureToleranceCount => 1, # OPTIONAL
50 FailureTolerancePercentage => 1, # max: 100; OPTIONAL
51 MaxConcurrentCount => 1, # min: 1; OPTIONAL
52 MaxConcurrentPercentage => 1, # min: 1, max: 100; OPTIONAL
53 RegionConcurrencyType =>
54 'SEQUENTIAL', # values: SEQUENTIAL, PARALLEL; OPTIONAL
55 RegionOrder => [ 'MyRegion', ... ],
56 }, # OPTIONAL
57 ParameterOverrides => [
58 {
59 ParameterKey => 'MyParameterKey', # OPTIONAL
60 ParameterValue => 'MyParameterValue', # OPTIONAL
61 ResolvedValue => 'MyParameterValue', # OPTIONAL
62 UsePreviousValue => 1, # OPTIONAL
63 },
64 ...
65 ], # OPTIONAL
66 );
67  
68 # Results:
69 my $OperationId = $CreateStackInstancesOutput->OperationId;
70  
71 # Returns a L<Paws::CloudFormation::CreateStackInstancesOutput> object.
72  
73 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.
74 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudformation/CreateStackInstances>
75  
76 =head1 ATTRIBUTES
77  
78  
79 =head2 Accounts => ArrayRef[Str|Undef]
80  
81 [Self-managed permissions] The names of one or more AWS accounts that
82 you want to create stack instances in the specified Region(s) for.
83  
84 You can specify C<Accounts> or C<DeploymentTargets>, but not both.
85  
86  
87  
88 =head2 CallAs => Str
89  
90 [Service-managed permissions] Specifies whether you are acting as an
91 account administrator in the organization's management account or as a
92 delegated administrator in a member account.
93  
94 By default, C<SELF> is specified. Use C<SELF> for stack sets with
95 self-managed permissions.
96  
97 =over
98  
99 =item *
100  
101 If you are signed in to the management account, specify C<SELF>.
102  
103 =item *
104  
105 If you are signed in to a delegated administrator account, specify
106 C<DELEGATED_ADMIN>.
107  
108 Your AWS account must be registered as a delegated administrator in the
109 management account. For more information, see Register a delegated
110 administrator
111 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
112 in the I<AWS CloudFormation User Guide>.
113  
114 =back
115  
116  
117 Valid values are: C<"SELF">, C<"DELEGATED_ADMIN">
118  
119 =head2 DeploymentTargets => L<Paws::CloudFormation::DeploymentTargets>
120  
121 [Service-managed permissions] The AWS Organizations accounts for which
122 to create stack instances in the specified Regions.
123  
124 You can specify C<Accounts> or C<DeploymentTargets>, but not both.
125  
126  
127  
128 =head2 OperationId => Str
129  
130 The unique identifier for this stack set operation.
131  
132 The operation ID also functions as an idempotency token, to ensure that
133 AWS CloudFormation performs the stack set operation only once, even if
134 you retry the request multiple times. You might retry stack set
135 operation requests to ensure that AWS CloudFormation successfully
136 received them.
137  
138 If you don't specify an operation ID, the SDK generates one
139 automatically.
140  
141 Repeating this stack set operation with a new operation ID retries all
142 stack instances whose status is C<OUTDATED>.
143  
144  
145  
146 =head2 OperationPreferences => L<Paws::CloudFormation::StackSetOperationPreferences>
147  
148 Preferences for how AWS CloudFormation performs this stack set
149 operation.
150  
151  
152  
153 =head2 ParameterOverrides => ArrayRef[L<Paws::CloudFormation::Parameter>]
154  
155 A list of stack set parameters whose values you want to override in the
156 selected stack instances.
157  
158 Any overridden parameter values will be applied to all stack instances
159 in the specified accounts and Regions. When specifying parameters and
160 their values, be aware of how AWS CloudFormation sets parameter values
161 during stack instance operations:
162  
163 =over
164  
165 =item *
166  
167 To override the current value for a parameter, include the parameter
168 and specify its value.
169  
170 =item *
171  
172 To leave a parameter set to its present value, you can do one of the
173 following:
174  
175 =over
176  
177 =item *
178  
179 Do not include the parameter in the list.
180  
181 =item *
182  
183 Include the parameter and specify C<UsePreviousValue> as C<true>. (You
184 cannot specify both a value and set C<UsePreviousValue> to C<true>.)
185  
186 =back
187  
188 =item *
189  
190 To set all overridden parameter back to the values specified in the
191 stack set, specify a parameter list but do not include any parameters.
192  
193 =item *
194  
195 To leave all parameters set to their present values, do not specify
196 this property at all.
197  
198 =back
199  
200 During stack set updates, any parameter values overridden for a stack
201 instance are not updated, but retain their overridden value.
202  
203 You can only override the parameter I<values> that are specified in the
204 stack set; to add or delete a parameter itself, use UpdateStackSet
205 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html)
206 to update the stack set template.
207  
208  
209  
210 =head2 B<REQUIRED> Regions => ArrayRef[Str|Undef]
211  
212 The names of one or more Regions where you want to create stack
213 instances using the specified AWS account(s).
214  
215  
216  
217 =head2 B<REQUIRED> StackSetName => Str
218  
219 The name or unique ID of the stack set that you want to create stack
220 instances from.
221  
222  
223  
224  
225 =head1 SEE ALSO
226  
227 This class forms part of L<Paws>, documenting arguments for method CreateStackInstances in L<Paws::CloudFormation>
228  
229 =head1 BUGS and CONTRIBUTIONS
230  
231 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
232  
233 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
234  
235 =cut
236