| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSM::Runbook; | ||
| 3 | use Moose; | ||
| 4 | has DocumentName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DocumentVersion => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxConcurrency => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxErrors => (is => 'ro', isa => 'Str'); | ||
| 8 | has Parameters => (is => 'ro', isa => 'Paws::SSM::AutomationParameterMap'); | ||
| 9 | has TargetLocations => (is => 'ro', isa => 'ArrayRef[Paws::SSM::TargetLocation]'); | ||
| 10 | has TargetParameterName => (is => 'ro', isa => 'Str'); | ||
| 11 | has Targets => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Target]'); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::SSM::Runbook | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::SSM::Runbook object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { DocumentName => $value, ..., Targets => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::Runbook object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->DocumentName | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Information about an Automation runbook (Automation document) used in a | ||
| 44 | runbook workflow in Change Manager. | ||
| 45 | |||
| 46 | The Automation runbooks specified for the runbook workflow can't run | ||
| 47 | until all required approvals for the change request have been received. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> DocumentName => Str | ||
| 53 | |||
| 54 | The name of the Automation runbook (Automation document) used in a | ||
| 55 | runbook workflow. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 DocumentVersion => Str | ||
| 59 | |||
| 60 | The version of the Automation runbook (Automation document) used in a | ||
| 61 | runbook workflow. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 MaxConcurrency => Str | ||
| 65 | |||
| 66 | The C<MaxConcurrency> value specified by the user when the operation | ||
| 67 | started, indicating the maximum number of resources that the runbook | ||
| 68 | operation can run on at the same time. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 MaxErrors => Str | ||
| 72 | |||
| 73 | The C<MaxErrors> value specified by the user when the execution | ||
| 74 | started, indicating the maximum number of errors that can occur during | ||
| 75 | the operation before the updates are stopped or rolled back. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Parameters => L<Paws::SSM::AutomationParameterMap> | ||
| 79 | |||
| 80 | The key-value map of execution parameters, which were supplied when | ||
| 81 | calling C<StartChangeRequestExecution>. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 TargetLocations => ArrayRef[L<Paws::SSM::TargetLocation>] | ||
| 85 | |||
| 86 | Information about the AWS Regions and accounts targeted by the current | ||
| 87 | Runbook operation. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 TargetParameterName => Str | ||
| 91 | |||
| 92 | The name of the parameter used as the target resource for the | ||
| 93 | rate-controlled runbook workflow. Required if you specify C<Targets>. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 Targets => ArrayRef[L<Paws::SSM::Target>] | ||
| 97 | |||
| 98 | A key-value mapping to target resources that the Runbook operation | ||
| 99 | performs tasks on. Required if you specify C<TargetParameterName>. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, describing an object used in L<Paws::SSM> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |