CreateAssociationBatchRequestEntry
Describes the association of a Systems Manager SSM document and an instance.
Contents
- AssociationName
-
Specify a descriptive name for the association.
Type: String
Pattern:
^[a-zA-Z0-9_\-.]{3,128}$Required: No
- ComplianceSeverity
-
The severity level to assign to the association.
Type: String
Valid Values:
CRITICAL | HIGH | MEDIUM | LOW | UNSPECIFIEDRequired: No
- DocumentVersion
-
The document version.
Type: String
Pattern:
([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)Required: No
- InstanceId
-
The ID of the instance.
Type: String
Pattern:
(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)Required: No
- MaxConcurrency
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 7.
Pattern:
^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$Required: No
- MaxErrors
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 7.
Pattern:
^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$Required: No
- Name
-
The name of the configuration document.
Type: String
Pattern:
^[a-zA-Z0-9_\-.]{3,128}$Required: Yes
- OutputLocation
-
An Amazon S3 bucket where you want to store the results of this request.
Type: InstanceAssociationOutputLocation object
Required: No
- Parameters
-
A description of the parameters for a document.
Type: String to array of strings map
Required: No
- ScheduleExpression
-
A cron expression that specifies a schedule when the association runs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- Targets
-
The instances targeted by the request.
Type: Array of Target objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
