« blib/lib/Paws/SSMIncidents/ResponsePlanSummary.pm
↑ Summary
blib/lib/Paws/SSMIncidents/SsmParameters.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSMIncidents::SsmAutomation; | ||
| 3 | use Moose; | ||
| 4 | has DocumentName => (is => 'ro', isa => 'Str', request_name => 'documentName', traits => ['NameInRequest'], required => 1); | ||
| 5 | has DocumentVersion => (is => 'ro', isa => 'Str', request_name => 'documentVersion', traits => ['NameInRequest']); | ||
| 6 | has Parameters => (is => 'ro', isa => 'Paws::SSMIncidents::SsmParameters', request_name => 'parameters', traits => ['NameInRequest']); | ||
| 7 | has RoleArn => (is => 'ro', isa => 'Str', request_name => 'roleArn', traits => ['NameInRequest'], required => 1); | ||
| 8 | has TargetAccount => (is => 'ro', isa => 'Str', request_name => 'targetAccount', traits => ['NameInRequest']); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::SSMIncidents::SsmAutomation | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::SSMIncidents::SsmAutomation object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { DocumentName => $value, ..., TargetAccount => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSMIncidents::SsmAutomation object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->DocumentName | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Details about the Systems Manager automation document that will be used | ||
| 41 | as a runbook during an incident. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> DocumentName => Str | ||
| 47 | |||
| 48 | The automation document's name. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 DocumentVersion => Str | ||
| 52 | |||
| 53 | The automation document's version to use when running. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 Parameters => L<Paws::SSMIncidents::SsmParameters> | ||
| 57 | |||
| 58 | The key-value pair parameters to use when running the automation | ||
| 59 | document. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> RoleArn => Str | ||
| 63 | |||
| 64 | The Amazon Resource Name (ARN) of the role that the automation document | ||
| 65 | will assume when running commands. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 TargetAccount => Str | ||
| 69 | |||
| 70 | The account that the automation document will be run in. This can be in | ||
| 71 | either the management account or an application account. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, describing an object used in L<Paws::SSMIncidents> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |