« blib/lib/Paws/SSM/AssociationStatusAggregatedCount.pm
↑ Summary
blib/lib/Paws/SSM/AttachmentContent.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SSM::AssociationVersionInfo; | ||
| 3 | use Moose; | ||
| 4 | has ApplyOnlyAtCronInterval => (is => 'ro', isa => 'Bool'); | ||
| 5 | has AssociationId => (is => 'ro', isa => 'Str'); | ||
| 6 | has AssociationName => (is => 'ro', isa => 'Str'); | ||
| 7 | has AssociationVersion => (is => 'ro', isa => 'Str'); | ||
| 8 | has CalendarNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has ComplianceSeverity => (is => 'ro', isa => 'Str'); | ||
| 10 | has CreatedDate => (is => 'ro', isa => 'Str'); | ||
| 11 | has DocumentVersion => (is => 'ro', isa => 'Str'); | ||
| 12 | has MaxConcurrency => (is => 'ro', isa => 'Str'); | ||
| 13 | has MaxErrors => (is => 'ro', isa => 'Str'); | ||
| 14 | has Name => (is => 'ro', isa => 'Str'); | ||
| 15 | has OutputLocation => (is => 'ro', isa => 'Paws::SSM::InstanceAssociationOutputLocation'); | ||
| 16 | has Parameters => (is => 'ro', isa => 'Paws::SSM::Parameters'); | ||
| 17 | has ScheduleExpression => (is => 'ro', isa => 'Str'); | ||
| 18 | has SyncCompliance => (is => 'ro', isa => 'Str'); | ||
| 19 | has TargetLocations => (is => 'ro', isa => 'ArrayRef[Paws::SSM::TargetLocation]'); | ||
| 20 | has Targets => (is => 'ro', isa => 'ArrayRef[Paws::SSM::Target]'); | ||
| 21 | |||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::SSM::AssociationVersionInfo | ||
| 29 | |||
| 30 | =head1 USAGE | ||
| 31 | |||
| 32 | This class represents one of two things: | ||
| 33 | |||
| 34 | =head3 Arguments in a call to a service | ||
| 35 | |||
| 36 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 37 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 38 | |||
| 39 | As an example, if Att1 is expected to be a Paws::SSM::AssociationVersionInfo object: | ||
| 40 | |||
| 41 | $service_obj->Method(Att1 => { ApplyOnlyAtCronInterval => $value, ..., Targets => $value }); | ||
| 42 | |||
| 43 | =head3 Results returned from an API call | ||
| 44 | |||
| 45 | Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::AssociationVersionInfo object: | ||
| 46 | |||
| 47 | $result = $service_obj->Method(...); | ||
| 48 | $result->Att1->ApplyOnlyAtCronInterval | ||
| 49 | |||
| 50 | =head1 DESCRIPTION | ||
| 51 | |||
| 52 | Information about the association version. | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 ApplyOnlyAtCronInterval => Bool | ||
| 58 | |||
| 59 | By default, when you create a new associations, the system runs it | ||
| 60 | immediately after it is created and then according to the schedule you | ||
| 61 | specified. Specify this option if you don't want an association to run | ||
| 62 | immediately after you create it. This parameter is not supported for | ||
| 63 | rate expressions. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 AssociationId => Str | ||
| 67 | |||
| 68 | The ID created by the system when the association was created. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 AssociationName => Str | ||
| 72 | |||
| 73 | The name specified for the association version when the association | ||
| 74 | version was created. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 AssociationVersion => Str | ||
| 78 | |||
| 79 | The association version. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 CalendarNames => ArrayRef[Str|Undef] | ||
| 83 | |||
| 84 | The names or Amazon Resource Names (ARNs) of the Systems Manager Change | ||
| 85 | Calendar type documents your associations are gated under. The | ||
| 86 | associations for this version only run when that Change Calendar is | ||
| 87 | open. For more information, see AWS Systems Manager Change Calendar | ||
| 88 | (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar). | ||
| 89 | |||
| 90 | |||
| 91 | =head2 ComplianceSeverity => Str | ||
| 92 | |||
| 93 | The severity level that is assigned to the association. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 CreatedDate => Str | ||
| 97 | |||
| 98 | The date the association version was created. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 DocumentVersion => Str | ||
| 102 | |||
| 103 | The version of a Systems Manager document used when the association | ||
| 104 | version was created. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 MaxConcurrency => Str | ||
| 108 | |||
| 109 | The maximum number of targets allowed to run the association at the | ||
| 110 | same time. You can specify a number, for example 10, or a percentage of | ||
| 111 | the target set, for example 10%. The default value is 100%, which means | ||
| 112 | all targets run the association at the same time. | ||
| 113 | |||
| 114 | If a new instance starts and attempts to run an association while | ||
| 115 | Systems Manager is running MaxConcurrency associations, the association | ||
| 116 | is allowed to run. During the next association interval, the new | ||
| 117 | instance will process its association within the limit specified for | ||
| 118 | MaxConcurrency. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 MaxErrors => Str | ||
| 122 | |||
| 123 | The number of errors that are allowed before the system stops sending | ||
| 124 | requests to run the association on additional targets. You can specify | ||
| 125 | either an absolute number of errors, for example 10, or a percentage of | ||
| 126 | the target set, for example 10%. If you specify 3, for example, the | ||
| 127 | system stops sending requests when the fourth error is received. If you | ||
| 128 | specify 0, then the system stops sending requests after the first error | ||
| 129 | is returned. If you run an association on 50 instances and set MaxError | ||
| 130 | to 10%, then the system stops sending the request when the sixth error | ||
| 131 | is received. | ||
| 132 | |||
| 133 | Executions that are already running an association when MaxErrors is | ||
| 134 | reached are allowed to complete, but some of these executions may fail | ||
| 135 | as well. If you need to ensure that there won't be more than max-errors | ||
| 136 | failed executions, set MaxConcurrency to 1 so that executions proceed | ||
| 137 | one at a time. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 Name => Str | ||
| 141 | |||
| 142 | The name specified when the association was created. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 OutputLocation => L<Paws::SSM::InstanceAssociationOutputLocation> | ||
| 146 | |||
| 147 | The location in Amazon S3 specified for the association when the | ||
| 148 | association version was created. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 Parameters => L<Paws::SSM::Parameters> | ||
| 152 | |||
| 153 | Parameters specified when the association version was created. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 ScheduleExpression => Str | ||
| 157 | |||
| 158 | The cron or rate schedule specified for the association when the | ||
| 159 | association version was created. | ||
| 160 | |||
| 161 | |||
| 162 | =head2 SyncCompliance => Str | ||
| 163 | |||
| 164 | The mode for generating association compliance. You can specify C<AUTO> | ||
| 165 | or C<MANUAL>. In C<AUTO> mode, the system uses the status of the | ||
| 166 | association execution to determine the compliance status. If the | ||
| 167 | association execution runs successfully, then the association is | ||
| 168 | C<COMPLIANT>. If the association execution doesn't run successfully, | ||
| 169 | the association is C<NON-COMPLIANT>. | ||
| 170 | |||
| 171 | In C<MANUAL> mode, you must specify the C<AssociationId> as a parameter | ||
| 172 | for the PutComplianceItems API action. In this case, compliance data is | ||
| 173 | not managed by State Manager. It is managed by your direct call to the | ||
| 174 | PutComplianceItems API action. | ||
| 175 | |||
| 176 | By default, all associations use C<AUTO> mode. | ||
| 177 | |||
| 178 | |||
| 179 | =head2 TargetLocations => ArrayRef[L<Paws::SSM::TargetLocation>] | ||
| 180 | |||
| 181 | The combination of AWS Regions and AWS accounts where you wanted to run | ||
| 182 | the association when this association version was created. | ||
| 183 | |||
| 184 | |||
| 185 | =head2 Targets => ArrayRef[L<Paws::SSM::Target>] | ||
| 186 | |||
| 187 | The targets specified for the association when the association version | ||
| 188 | was created. | ||
| 189 | |||
| 190 | |||
| 191 | |||
| 192 | =head1 SEE ALSO | ||
| 193 | |||
| 194 | This class forms part of L<Paws>, describing an object used in L<Paws::SSM> | ||
| 195 | |||
| 196 | =head1 BUGS and CONTRIBUTIONS | ||
| 197 | |||
| 198 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 199 | |||
| 200 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 201 | |||
| 202 | =cut | ||
| 203 |