File Coverage

blib/lib/Paws/SSM/RegisterTaskWithMaintenanceWindow.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::SSM::RegisterTaskWithMaintenanceWindow;
3 1     1   437 use Moose;
  1         4  
  1         6  
4             has ClientToken => (is => 'ro', isa => 'Str');
5             has Description => (is => 'ro', isa => 'Str');
6             has LoggingInfo => (is => 'ro', isa => 'Paws::SSM::LoggingInfo');
7             has MaxConcurrency => (is => 'ro', isa => 'Str', required => 1);
8             has MaxErrors => (is => 'ro', isa => 'Str', required => 1);
9             has Name => (is => 'ro', isa => 'Str');
10             has Priority => (is => 'ro', isa => 'Int');
11             has ServiceRoleArn => (is => 'ro', isa => 'Str', required => 1);
12             has Targets => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Target]', required => 1);
13             has TaskArn => (is => 'ro', isa => 'Str', required => 1);
14             has TaskInvocationParameters => (is => 'ro', isa => 'Paws::SSM::MaintenanceWindowTaskInvocationParameters');
15             has TaskParameters => (is => 'ro', isa => 'Paws::SSM::MaintenanceWindowTaskParameters');
16             has TaskType => (is => 'ro', isa => 'Str', required => 1);
17             has WindowId => (is => 'ro', isa => 'Str', required => 1);
18              
19 1     1   5436 use MooseX::ClassAttribute;
  1         3  
  1         8  
20              
21             class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterTaskWithMaintenanceWindow');
22             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::RegisterTaskWithMaintenanceWindowResult');
23             class_has _result_key => (isa => 'Str', is => 'ro');
24             1;
25              
26             ### main pod documentation begin ###
27              
28             =head1 NAME
29              
30             Paws::SSM::RegisterTaskWithMaintenanceWindow - Arguments for method RegisterTaskWithMaintenanceWindow on Paws::SSM
31              
32             =head1 DESCRIPTION
33              
34             This class represents the parameters used for calling the method RegisterTaskWithMaintenanceWindow on the
35             Amazon Simple Systems Manager (SSM) service. Use the attributes of this class
36             as arguments to method RegisterTaskWithMaintenanceWindow.
37              
38             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterTaskWithMaintenanceWindow.
39              
40             As an example:
41              
42             $service_obj->RegisterTaskWithMaintenanceWindow(Att1 => $value1, Att2 => $value2, ...);
43              
44             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.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 ClientToken => Str
50              
51             User-provided idempotency token.
52              
53              
54              
55             =head2 Description => Str
56              
57             An optional description for the task.
58              
59              
60              
61             =head2 LoggingInfo => L<Paws::SSM::LoggingInfo>
62              
63             A structure containing information about an Amazon S3 bucket to write
64             instance-level logs to.
65              
66              
67              
68             =head2 B<REQUIRED> MaxConcurrency => Str
69              
70             The maximum number of targets this task can be run for in parallel.
71              
72              
73              
74             =head2 B<REQUIRED> MaxErrors => Str
75              
76             The maximum number of errors allowed before this task stops being
77             scheduled.
78              
79              
80              
81             =head2 Name => Str
82              
83             An optional name for the task.
84              
85              
86              
87             =head2 Priority => Int
88              
89             The priority of the task in the Maintenance Window, the lower the
90             number the higher the priority. Tasks in a Maintenance Window are
91             scheduled in priority order with tasks that have the same priority
92             scheduled in parallel.
93              
94              
95              
96             =head2 B<REQUIRED> ServiceRoleArn => Str
97              
98             The role that should be assumed when executing the task.
99              
100              
101              
102             =head2 B<REQUIRED> Targets => ArrayRef[L<Paws::SSM::Target>]
103              
104             The targets (either instances or tags). Instances are specified using
105             Key=instanceids,Values=E<lt>instanceid1E<gt>,E<lt>instanceid2E<gt>.
106             Tags are specified using Key=E<lt>tag nameE<gt>,Values=E<lt>tag
107             valueE<gt>.
108              
109              
110              
111             =head2 B<REQUIRED> TaskArn => Str
112              
113             The ARN of the task to execute
114              
115              
116              
117             =head2 TaskInvocationParameters => L<Paws::SSM::MaintenanceWindowTaskInvocationParameters>
118              
119             The parameters that the task should use during execution. Populate only
120             the fields that match the task type. All other fields should be empty.
121              
122              
123              
124             =head2 TaskParameters => L<Paws::SSM::MaintenanceWindowTaskParameters>
125              
126             The parameters that should be passed to the task when it is executed.
127              
128              
129              
130             =head2 B<REQUIRED> TaskType => Str
131              
132             The type of task being registered.
133              
134             Valid values are: C<"RUN_COMMAND">, C<"AUTOMATION">, C<"STEP_FUNCTIONS">, C<"LAMBDA">
135              
136             =head2 B<REQUIRED> WindowId => Str
137              
138             The id of the Maintenance Window the task should be added to.
139              
140              
141              
142              
143             =head1 SEE ALSO
144              
145             This class forms part of L<Paws>, documenting arguments for method RegisterTaskWithMaintenanceWindow in L<Paws::SSM>
146              
147             =head1 BUGS and CONTRIBUTIONS
148              
149             The source code is located here: https://github.com/pplu/aws-sdk-perl
150              
151             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
152              
153             =cut
154