« blib/lib/Paws/SSM/MaintenanceWindowTarget.pm
↑ Summary
blib/lib/Paws/SSM/MaintenanceWindowTaskInvocationParameters.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSM::MaintenanceWindowTask; | ||
| 3 | use Moose; | ||
| 4 | has Description => (is => 'ro', isa => 'Str'); | ||
| 5 | has LoggingInfo => (is => 'ro', isa => 'Paws::SSM::LoggingInfo'); | ||
| 6 | has MaxConcurrency => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxErrors => (is => 'ro', isa => 'Str'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str'); | ||
| 9 | has Priority => (is => 'ro', isa => 'Int'); | ||
| 10 | has ServiceRoleArn => (is => 'ro', isa => 'Str'); | ||
| 11 | has Targets => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Target]'); | ||
| 12 | has TaskArn => (is => 'ro', isa => 'Str'); | ||
| 13 | has TaskParameters => (is => 'ro', isa => 'Paws::SSM::MaintenanceWindowTaskParameters'); | ||
| 14 | has Type => (is => 'ro', isa => 'Str'); | ||
| 15 | has WindowId => (is => 'ro', isa => 'Str'); | ||
| 16 | has WindowTaskId => (is => 'ro', isa => 'Str'); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::SSM::MaintenanceWindowTask | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::SSM::MaintenanceWindowTask object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { Description => $value, ..., WindowTaskId => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::MaintenanceWindowTask object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->Description | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Information about a task defined for a maintenance window. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Description => Str | ||
| 54 | |||
| 55 | A description of the task. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 LoggingInfo => L<Paws::SSM::LoggingInfo> | ||
| 59 | |||
| 60 | Information about an S3 bucket to write task-level logs to. | ||
| 61 | |||
| 62 | C<LoggingInfo> has been deprecated. To specify an S3 bucket to contain | ||
| 63 | logs, instead use the C<OutputS3BucketName> and C<OutputS3KeyPrefix> | ||
| 64 | options in the C<TaskInvocationParameters> structure. For information | ||
| 65 | about how Systems Manager handles these options for the supported | ||
| 66 | maintenance window task types, see | ||
| 67 | MaintenanceWindowTaskInvocationParameters. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 MaxConcurrency => Str | ||
| 71 | |||
| 72 | The maximum number of targets this task can be run for, in parallel. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 MaxErrors => Str | ||
| 76 | |||
| 77 | The maximum number of errors allowed before this task stops being | ||
| 78 | scheduled. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 Name => Str | ||
| 82 | |||
| 83 | The task name. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 Priority => Int | ||
| 87 | |||
| 88 | The priority of the task in the maintenance window. The lower the | ||
| 89 | number, the higher the priority. Tasks that have the same priority are | ||
| 90 | scheduled in parallel. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 ServiceRoleArn => Str | ||
| 94 | |||
| 95 | The ARN of the IAM service role to use to publish Amazon Simple | ||
| 96 | Notification Service (Amazon SNS) notifications for maintenance window | ||
| 97 | Run Command tasks. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 Targets => ArrayRef[L<Paws::SSM::Target>] | ||
| 101 | |||
| 102 | The targets (either instances or tags). Instances are specified using | ||
| 103 | Key=instanceids,Values=E<lt>instanceid1E<gt>,E<lt>instanceid2E<gt>. | ||
| 104 | Tags are specified using Key=E<lt>tag nameE<gt>,Values=E<lt>tag | ||
| 105 | valueE<gt>. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 TaskArn => Str | ||
| 109 | |||
| 110 | The resource that the task uses during execution. For RUN_COMMAND and | ||
| 111 | AUTOMATION task types, C<TaskArn> is the Systems Manager document name | ||
| 112 | or ARN. For LAMBDA tasks, it's the function name or ARN. For | ||
| 113 | STEP_FUNCTIONS tasks, it's the state machine ARN. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 TaskParameters => L<Paws::SSM::MaintenanceWindowTaskParameters> | ||
| 117 | |||
| 118 | The parameters that should be passed to the task when it is run. | ||
| 119 | |||
| 120 | C<TaskParameters> has been deprecated. To specify parameters to pass to | ||
| 121 | a task when it runs, instead use the C<Parameters> option in the | ||
| 122 | C<TaskInvocationParameters> structure. For information about how | ||
| 123 | Systems Manager handles these options for the supported maintenance | ||
| 124 | window task types, see MaintenanceWindowTaskInvocationParameters. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 Type => Str | ||
| 128 | |||
| 129 | The type of task. The type can be one of the following: RUN_COMMAND, | ||
| 130 | AUTOMATION, LAMBDA, or STEP_FUNCTIONS. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 WindowId => Str | ||
| 134 | |||
| 135 | The ID of the maintenance window where the task is registered. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 WindowTaskId => Str | ||
| 139 | |||
| 140 | The task ID. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head1 SEE ALSO | ||
| 145 | |||
| 146 | This class forms part of L<Paws>, describing an object used in L<Paws::SSM> | ||
| 147 | |||
| 148 | =head1 BUGS and CONTRIBUTIONS | ||
| 149 | |||
| 150 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 151 | |||
| 152 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 153 | |||
| 154 | =cut | ||
| 155 |