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