NAME
Paws::SSM::CreateAssociationBatchRequestEntry
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::SSM::CreateAssociationBatchRequestEntry object:
$service_obj->Method(Att1 => { ApplyOnlyAtCronInterval => $value, ..., Targets => $value });Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::CreateAssociationBatchRequestEntry object:
$result = $service_obj->Method(...);
$result->Att1->ApplyOnlyAtCronIntervalDESCRIPTION
Describes the association of a Systems Manager SSM document and an instance.
ATTRIBUTES
ApplyOnlyAtCronInterval => Bool
By default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified. Specify this option if you don't want an association to run immediately after you create it. This parameter is not supported for rate expressions.
AssociationName => Str
Specify a descriptive name for the association.
AutomationTargetParameterName => Str
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
CalendarNames => ArrayRef[Str|Undef]
The names or Amazon Resource Names (ARNs) of the Systems Manager Change Calendar type documents your associations are gated under. The associations only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar (https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar).
ComplianceSeverity => Str
The severity level to assign to the association.
DocumentVersion => Str
The document version.
InstanceId => Str
The ID of the instance.
MaxConcurrency => Str
The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.
If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.
MaxErrors => Str
The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.
Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.
REQUIRED Name => Str
The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.
You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.
For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:
arn:aws:ssm:region:account-id:document/document-name
For example:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document
For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.
OutputLocation => Paws::SSM::InstanceAssociationOutputLocation
An S3 bucket where you want to store the results of this request.
Parameters => Paws::SSM::Parameters
A description of the parameters for a document.
ScheduleExpression => Str
A cron expression that specifies a schedule when the association runs.
SyncCompliance => Str
The mode for generating association compliance. You can specify AUTO or MANUAL. In AUTO mode, the system uses the status of the association execution to determine the compliance status. If the association execution runs successfully, then the association is COMPLIANT. If the association execution doesn't run successfully, the association is NON-COMPLIANT.
In MANUAL mode, you must specify the AssociationId as a parameter for the PutComplianceItems API action. In this case, compliance data is not managed by State Manager. It is managed by your direct call to the PutComplianceItems API action.
By default, all associations use AUTO mode.
TargetLocations => ArrayRef[Paws::SSM::TargetLocation]
Use this action to create an association in multiple Regions and multiple accounts.
Targets => ArrayRef[Paws::SSM::Target]
The instances targeted by the request.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::SSM
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues