blib/lib/Paws/CloudFormation/UpdateStackInstances.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::UpdateStackInstances;
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 => 'UpdateStackInstances');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudFormation::UpdateStackInstancesOutput');
17 class_has _result_key => (isa => 'Str', is => 'ro', default => 'UpdateStackInstancesResult');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::CloudFormation::UpdateStackInstances - Arguments for method UpdateStackInstances on L<Paws::CloudFormation>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method UpdateStackInstances on the
29 L<AWS CloudFormation|Paws::CloudFormation> service. Use the attributes of this class
30 as arguments to method UpdateStackInstances.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateStackInstances.
33  
34 =head1 SYNOPSIS
35  
36 my $cloudformation = Paws->service('CloudFormation');
37 my $UpdateStackInstancesOutput = $cloudformation->UpdateStackInstances(
38 Regions => [ 'MyRegion', ... ],
39 StackSetName => 'MyStackSetNameOrId',
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 = $UpdateStackInstancesOutput->OperationId;
70  
71 # Returns a L<Paws::CloudFormation::UpdateStackInstancesOutput> 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/UpdateStackInstances>
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 for
82 which you want to update parameter values for stack instances. The
83 overridden parameter values will be applied to all stack instances in
84 the specified accounts and Regions.
85  
86 You can specify C<Accounts> or C<DeploymentTargets>, but not both.
87  
88  
89  
90 =head2 CallAs => Str
91  
92 [Service-managed permissions] Specifies whether you are acting as an
93 account administrator in the organization's management account or as a
94 delegated administrator in a member account.
95  
96 By default, C<SELF> is specified. Use C<SELF> for stack sets with
97 self-managed permissions.
98  
99 =over
100  
101 =item *
102  
103 If you are signed in to the management account, specify C<SELF>.
104  
105 =item *
106  
107 If you are signed in to a delegated administrator account, specify
108 C<DELEGATED_ADMIN>.
109  
110 Your AWS account must be registered as a delegated administrator in the
111 management account. For more information, see Register a delegated
112 administrator
113 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html)
114 in the I<AWS CloudFormation User Guide>.
115  
116 =back
117  
118  
119 Valid values are: C<"SELF">, C<"DELEGATED_ADMIN">
120  
121 =head2 DeploymentTargets => L<Paws::CloudFormation::DeploymentTargets>
122  
123 [Service-managed permissions] The AWS Organizations accounts for which
124 you want to update parameter values for stack instances. If your update
125 targets OUs, the overridden parameter values only apply to the accounts
126 that are currently in the target OUs and their child OUs. Accounts
127 added to the target OUs and their child OUs in the future won't use the
128 overridden values.
129  
130 You can specify C<Accounts> or C<DeploymentTargets>, but not both.
131  
132  
133  
134 =head2 OperationId => Str
135  
136 The unique identifier for this stack set operation.
137  
138 The operation ID also functions as an idempotency token, to ensure that
139 AWS CloudFormation performs the stack set operation only once, even if
140 you retry the request multiple times. You might retry stack set
141 operation requests to ensure that AWS CloudFormation successfully
142 received them.
143  
144 If you don't specify an operation ID, the SDK generates one
145 automatically.
146  
147  
148  
149 =head2 OperationPreferences => L<Paws::CloudFormation::StackSetOperationPreferences>
150  
151 Preferences for how AWS CloudFormation performs this stack set
152 operation.
153  
154  
155  
156 =head2 ParameterOverrides => ArrayRef[L<Paws::CloudFormation::Parameter>]
157  
158 A list of input parameters whose values you want to update for the
159 specified stack instances.
160  
161 Any overridden parameter values will be applied to all stack instances
162 in the specified accounts and Regions. When specifying parameters and
163 their values, be aware of how AWS CloudFormation sets parameter values
164 during stack instance update operations:
165  
166 =over
167  
168 =item *
169  
170 To override the current value for a parameter, include the parameter
171 and specify its value.
172  
173 =item *
174  
175 To leave a parameter set to its present value, you can do one of the
176 following:
177  
178 =over
179  
180 =item *
181  
182 Do not include the parameter in the list.
183  
184 =item *
185  
186 Include the parameter and specify C<UsePreviousValue> as C<true>. (You
187 cannot specify both a value and set C<UsePreviousValue> to C<true>.)
188  
189 =back
190  
191 =item *
192  
193 To set all overridden parameter back to the values specified in the
194 stack set, specify a parameter list but do not include any parameters.
195  
196 =item *
197  
198 To leave all parameters set to their present values, do not specify
199 this property at all.
200  
201 =back
202  
203 During stack set updates, any parameter values overridden for a stack
204 instance are not updated, but retain their overridden value.
205  
206 You can only override the parameter I<values> that are specified in the
207 stack set; to add or delete a parameter itself, use C<UpdateStackSet>
208 to update the stack set template. If you add a parameter to a template,
209 before you can override the parameter value specified in the stack set
210 you must first use UpdateStackSet
211 (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html)
212 to update all stack instances with the updated template and parameter
213 value specified in the stack set. Once a stack instance has been
214 updated with the new parameter, you can then override the parameter
215 value using C<UpdateStackInstances>.
216  
217  
218  
219 =head2 B<REQUIRED> Regions => ArrayRef[Str|Undef]
220  
221 The names of one or more Regions in which you want to update parameter
222 values for stack instances. The overridden parameter values will be
223 applied to all stack instances in the specified accounts and Regions.
224  
225  
226  
227 =head2 B<REQUIRED> StackSetName => Str
228  
229 The name or unique ID of the stack set associated with the stack
230 instances.
231  
232  
233  
234  
235 =head1 SEE ALSO
236  
237 This class forms part of L<Paws>, documenting arguments for method UpdateStackInstances in L<Paws::CloudFormation>
238  
239 =head1 BUGS and CONTRIBUTIONS
240  
241 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
242  
243 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
244  
245 =cut
246