You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SSM::Types::AssociationDescriptionBy default, when you create a new associations, the system runs it immediately after it is created and then according to the schedule you specified.
The association ID.
The association name.
The association version.
Specify the target for the association.
The severity level that is assigned to the association.
The date when the association was made.
The document version.
The ID of the instance.
The date on which the association was last run.
The last date on which the association was successfully run.
The date when the association was last updated.
The maximum number of targets allowed to run the association at the same time.
The number of errors that are allowed before the system stops sending requests to run the association on additional targets.
The name of the Systems Manager document.
An S3 bucket where you want to store the output details of the request.
Information about the association.
A description of the parameters for a document.
A cron expression that specifies a schedule when the association runs.
The association status.
The mode for generating association compliance.
The instances targeted by the request.
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.
#association_name ⇒ String #association_version ⇒ String #automation_target_parameter_name ⇒ StringSpecify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
#compliance_severity ⇒ StringThe severity level that is assigned to the association.
Possible values:
The date when the association was made.
#document_version ⇒ String #last_execution_date ⇒ TimeThe date on which the association was last run.
#last_successful_execution_date ⇒ TimeThe last date on which the association was successfully run.
#last_update_association_date ⇒ TimeThe date when the association was last updated.
#max_concurrency ⇒ StringThe 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.
#max_errors ⇒ StringThe 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.
#name ⇒ StringThe name of the Systems Manager document.
#parameters ⇒ Hash<String,Array<String>>A description of the parameters for a document.
#schedule_expression ⇒ StringA cron expression that specifies a schedule when the association runs.
#sync_compliance ⇒ StringThe 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.
Possible values:
The instances targeted by the request.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4