Systems Manager Association

Systems Manager Association in AWS defines a configuration that automatically applies Systems Manager documents (SSM documents) to managed instances. It allows you to schedule and enforce tasks such as installing applications, running scripts, or applying patches across your fleet. Associations ensure that desired state configurations are consistently applied and maintained without manual intervention.

aws.ssm_association

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
alarm_configurationcorejsonThe details for the CloudWatch alarm you want to apply to an automation or command.
apply_only_at_cron_intervalcoreboolBy 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 isn't supported for rate expressions.
association_idcorestringThe association ID.
association_namecorestringThe association name.
association_versioncorestringThe association version.
automation_target_parameter_namecorestringChoose the parameter that will define how your automation will branch out. This target is required for associations that use an Automation runbook and target resources by using rate controls. Automation is a tool in Amazon Web Services Systems Manager.
calendar_namescorearray<string>The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations only run when that change calendar is open. For more information, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.
compliance_severitycorestringThe severity level that is assigned to the association.
datecoretimestampThe date when the association was made.
document_versioncorestringThe document version.
durationcoreint64The number of hours that an association can run on specified targets. After the resulting cutoff time passes, associations that are currently running are cancelled, and no pending executions are started on remaining targets.
instance_idcorestringThe managed node ID.
last_execution_datecoretimestampThe date on which the association was last run.
last_successful_execution_datecoretimestampThe last date on which the association was successfully run.
last_update_association_datecoretimestampThe date when the association was last updated.
max_concurrencycorestringThe 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 managed node 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 managed node will process its association within the limit specified for MaxConcurrency.
max_errorscorestringThe 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 managed nodes 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.
namecorestringThe name of the SSM document.
output_locationcorejsonAn S3 bucket where you want to store the output details of the request.
overviewcorejsonInformation about the association.
parameterscorestringA description of the parameters for a document.
schedule_expressioncorestringA cron expression that specifies a schedule when the association runs.
schedule_offsetcoreint64Number of days to wait after the scheduled day to run an association.
statuscorejsonThe association status.
sync_compliancecorestringThe 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 operation. In this case, compliance data isn't managed by State Manager, a tool in Amazon Web Services Systems Manager. It is managed by your direct call to the PutComplianceItems API operation. By default, all associations use AUTO mode.
tagscorehstore
target_locationscorejsonThe combination of Amazon Web Services Regions and Amazon Web Services accounts where you want to run the association.
target_mapscorearray<string>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.
targetscorejsonThe managed nodes targeted by the request.
triggered_alarmscorejsonThe CloudWatch alarm that was invoked during the association.