Associates the specified Systems Manager document with the specified instances or targets.
ssm_create_association(Name, DocumentVersion, InstanceId, Parameters,
Targets, ScheduleExpression, OutputLocation, AssociationName,
AutomationTargetParameterName, MaxErrors, MaxConcurrency,
ComplianceSeverity)[required] The name of the SSM document that contains the configuration information for the instance. You can specify Command, Policy, 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:<i>partition</i>:ssm:<i>region</i>:<i>account-id</i>:document/<i>document-name</i>
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.
The document version you want to associate with the target(s). Can be a specific version or the default version.
The instance ID.
The parameters for the documents runtime configuration.
The targets (either instances or tags) for the association.
A cron expression when the association will be applied to the target(s).
An Amazon S3 bucket where you want to store the output details of the request.
Specify a descriptive name for the association.
Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.
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.
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 execute an association while Systems Manager is executing 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.
The severity level to assign to the association.
svc$create_association(
Name = "string",
DocumentVersion = "string",
InstanceId = "string",
Parameters = list(
list(
"string"
)
),
Targets = list(
list(
Key = "string",
Values = list(
"string"
)
)
),
ScheduleExpression = "string",
OutputLocation = list(
S3Location = list(
OutputS3Region = "string",
OutputS3BucketName = "string",
OutputS3KeyPrefix = "string"
)
),
AssociationName = "string",
AutomationTargetParameterName = "string",
MaxErrors = "string",
MaxConcurrency = "string",
ComplianceSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"UNSPECIFIED"
)
When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.
If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.