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