blib/lib/Paws/SSM/UpdateAssociation.pm untested

filter: Statementstmt 0.0% 0 / 26 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 28 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SSM::UpdateAssociation;
3 use Moose;
4 has ApplyOnlyAtCronInterval => (is => 'ro', isa => 'Bool');
5 has AssociationId => (is => 'ro', isa => 'Str', required => 1);
6 has AssociationName => (is => 'ro', isa => 'Str');
7 has AssociationVersion => (is => 'ro', isa => 'Str');
8 has AutomationTargetParameterName => (is => 'ro', isa => 'Str');
9 has CalendarNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10 has ComplianceSeverity => (is => 'ro', isa => 'Str');
11 has DocumentVersion => (is => 'ro', isa => 'Str');
12 has MaxConcurrency => (is => 'ro', isa => 'Str');
13 has MaxErrors => (is => 'ro', isa => 'Str');
14 has Name => (is => 'ro', isa => 'Str');
15 has OutputLocation => (is => 'ro', isa => 'Paws::SSM::InstanceAssociationOutputLocation');
16 has Parameters => (is => 'ro', isa => 'Paws::SSM::Parameters');
17 has ScheduleExpression => (is => 'ro', isa => 'Str');
18 has SyncCompliance => (is => 'ro', isa => 'Str');
19 has TargetLocations => (is => 'ro', isa => 'ArrayRef[Paws::SSM::TargetLocation]');
20 has Targets => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Target]');
21  
22 use MooseX::ClassAttribute;
23  
24 class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateAssociation');
25 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::UpdateAssociationResult');
26 class_has _result_key => (isa => 'Str', is => 'ro');
27 1;
28  
29 ### main pod documentation begin ###
30  
31 =head1 NAME
32  
33 Paws::SSM::UpdateAssociation - Arguments for method UpdateAssociation on L<Paws::SSM>
34  
35 =head1 DESCRIPTION
36  
37 This class represents the parameters used for calling the method UpdateAssociation on the
38 L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class
39 as arguments to method UpdateAssociation.
40  
41 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateAssociation.
42  
43 =head1 SYNOPSIS
44  
45 my $ssm = Paws->service('SSM');
46 my $UpdateAssociationResult = $ssm->UpdateAssociation(
47 AssociationId => 'MyAssociationId',
48 ApplyOnlyAtCronInterval => 1, # OPTIONAL
49 AssociationName => 'MyAssociationName', # OPTIONAL
50 AssociationVersion => 'MyAssociationVersion', # OPTIONAL
51 AutomationTargetParameterName =>
52 'MyAutomationTargetParameterName', # OPTIONAL
53 CalendarNames => [ 'MyCalendarNameOrARN', ... ], # OPTIONAL
54 ComplianceSeverity => 'CRITICAL', # OPTIONAL
55 DocumentVersion => 'MyDocumentVersion', # OPTIONAL
56 MaxConcurrency => 'MyMaxConcurrency', # OPTIONAL
57 MaxErrors => 'MyMaxErrors', # OPTIONAL
58 Name => 'MyDocumentARN', # OPTIONAL
59 OutputLocation => {
60 S3Location => {
61 OutputS3BucketName => 'MyS3BucketName', # min: 3, max: 63; OPTIONAL
62 OutputS3KeyPrefix => 'MyS3KeyPrefix', # max: 500; OPTIONAL
63 OutputS3Region => 'MyS3Region', # min: 3, max: 20; OPTIONAL
64 }, # OPTIONAL
65 }, # OPTIONAL
66 Parameters => { 'MyParameterName' => [ 'MyParameterValue', ... ], }
67 , # OPTIONAL
68 ScheduleExpression => 'MyScheduleExpression', # OPTIONAL
69 SyncCompliance => 'AUTO', # OPTIONAL
70 TargetLocations => [
71 {
72 Accounts => [ 'MyAccount', ... ], # min: 1, max: 50; OPTIONAL
73 ExecutionRoleName =>
74 'MyExecutionRoleName', # min: 1, max: 64; OPTIONAL
75 Regions => [ 'MyRegion', ... ], # min: 1, max: 50; OPTIONAL
76 TargetLocationMaxConcurrency => 'MyMaxConcurrency', # min: 1, max: 7
77 TargetLocationMaxErrors => 'MyMaxErrors', # min: 1, max: 7
78 },
79 ...
80 ], # OPTIONAL
81 Targets => [
82 {
83 Key => 'MyTargetKey', # min: 1, max: 163; OPTIONAL
84 Values => [ 'MyTargetValue', ... ], # max: 50; OPTIONAL
85 },
86 ...
87 ], # OPTIONAL
88 );
89  
90 # Results:
91 my $AssociationDescription =
92 $UpdateAssociationResult->AssociationDescription;
93  
94 # Returns a L<Paws::SSM::UpdateAssociationResult> object.
95  
96 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.
97 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/UpdateAssociation>
98  
99 =head1 ATTRIBUTES
100  
101  
102 =head2 ApplyOnlyAtCronInterval => Bool
103  
104 By default, when you update an association, the system runs it
105 immediately after it is updated and then according to the schedule you
106 specified. Specify this option if you don't want an association to run
107 immediately after you update it. This parameter is not supported for
108 rate expressions.
109  
110 Also, if you specified this option when you created the association,
111 you can reset it. To do so, specify the
112 C<no-apply-only-at-cron-interval> parameter when you update the
113 association from the command line. This parameter forces the
114 association to run immediately after updating it and according to the
115 interval specified.
116  
117  
118  
119 =head2 B<REQUIRED> AssociationId => Str
120  
121 The ID of the association you want to update.
122  
123  
124  
125 =head2 AssociationName => Str
126  
127 The name of the association that you want to update.
128  
129  
130  
131 =head2 AssociationVersion => Str
132  
133 This parameter is provided for concurrency control purposes. You must
134 specify the latest association version in the service. If you want to
135 ensure that this request succeeds, either specify C<$LATEST>, or omit
136 this parameter.
137  
138  
139  
140 =head2 AutomationTargetParameterName => Str
141  
142 Specify the target for the association. This target is required for
143 associations that use an Automation document and target resources by
144 using rate controls.
145  
146  
147  
148 =head2 CalendarNames => ArrayRef[Str|Undef]
149  
150 The names or Amazon Resource Names (ARNs) of the Systems Manager Change
151 Calendar type documents you want to gate your associations under. The
152 associations only run when that Change Calendar is open. For more
153 information, see AWS Systems Manager Change Calendar
154 (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar).
155  
156  
157  
158 =head2 ComplianceSeverity => Str
159  
160 The severity level to assign to the association.
161  
162 Valid values are: C<"CRITICAL">, C<"HIGH">, C<"MEDIUM">, C<"LOW">, C<"UNSPECIFIED">
163  
164 =head2 DocumentVersion => Str
165  
166 The document version you want update for the association.
167  
168  
169  
170 =head2 MaxConcurrency => Str
171  
172 The maximum number of targets allowed to run the association at the
173 same time. You can specify a number, for example 10, or a percentage of
174 the target set, for example 10%. The default value is 100%, which means
175 all targets run the association at the same time.
176  
177 If a new instance starts and attempts to run an association while
178 Systems Manager is running MaxConcurrency associations, the association
179 is allowed to run. During the next association interval, the new
180 instance will process its association within the limit specified for
181 MaxConcurrency.
182  
183  
184  
185 =head2 MaxErrors => Str
186  
187 The number of errors that are allowed before the system stops sending
188 requests to run the association on additional targets. You can specify
189 either an absolute number of errors, for example 10, or a percentage of
190 the target set, for example 10%. If you specify 3, for example, the
191 system stops sending requests when the fourth error is received. If you
192 specify 0, then the system stops sending requests after the first error
193 is returned. If you run an association on 50 instances and set MaxError
194 to 10%, then the system stops sending the request when the sixth error
195 is received.
196  
197 Executions that are already running an association when MaxErrors is
198 reached are allowed to complete, but some of these executions may fail
199 as well. If you need to ensure that there won't be more than max-errors
200 failed executions, set MaxConcurrency to 1 so that executions proceed
201 one at a time.
202  
203  
204  
205 =head2 Name => Str
206  
207 The name of the SSM document that contains the configuration
208 information for the instance. You can specify Command or Automation
209 documents.
210  
211 You can specify AWS-predefined documents, documents you created, or a
212 document that is shared with you from another account.
213  
214 For SSM documents that are shared with you from other AWS accounts, you
215 must specify the complete SSM document ARN, in the following format:
216  
217 C<arn:aws:ssm:I<region>:I<account-id>:document/I<document-name>>
218  
219 For example:
220  
221 C<arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document>
222  
223 For AWS-predefined documents and SSM documents you created in your
224 account, you only need to specify the document name. For example,
225 C<AWS-ApplyPatchBaseline> or C<My-Document>.
226  
227  
228  
229 =head2 OutputLocation => L<Paws::SSM::InstanceAssociationOutputLocation>
230  
231 An S3 bucket where you want to store the results of this request.
232  
233  
234  
235 =head2 Parameters => L<Paws::SSM::Parameters>
236  
237 The parameters you want to update for the association. If you create a
238 parameter using Parameter Store, you can reference the parameter using
239 {{ssm:parameter-name}}
240  
241  
242  
243 =head2 ScheduleExpression => Str
244  
245 The cron expression used to schedule the association that you want to
246 update.
247  
248  
249  
250 =head2 SyncCompliance => Str
251  
252 The mode for generating association compliance. You can specify C<AUTO>
253 or C<MANUAL>. In C<AUTO> mode, the system uses the status of the
254 association execution to determine the compliance status. If the
255 association execution runs successfully, then the association is
256 C<COMPLIANT>. If the association execution doesn't run successfully,
257 the association is C<NON-COMPLIANT>.
258  
259 In C<MANUAL> mode, you must specify the C<AssociationId> as a parameter
260 for the PutComplianceItems API action. In this case, compliance data is
261 not managed by State Manager. It is managed by your direct call to the
262 PutComplianceItems API action.
263  
264 By default, all associations use C<AUTO> mode.
265  
266 Valid values are: C<"AUTO">, C<"MANUAL">
267  
268 =head2 TargetLocations => ArrayRef[L<Paws::SSM::TargetLocation>]
269  
270 A location is a combination of AWS Regions and AWS accounts where you
271 want to run the association. Use this action to update an association
272 in multiple Regions and multiple accounts.
273  
274  
275  
276 =head2 Targets => ArrayRef[L<Paws::SSM::Target>]
277  
278 The targets of the association.
279  
280  
281  
282  
283 =head1 SEE ALSO
284  
285 This class forms part of L<Paws>, documenting arguments for method UpdateAssociation in L<Paws::SSM>
286  
287 =head1 BUGS and CONTRIBUTIONS
288  
289 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
290  
291 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
292  
293 =cut
294