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