AssociationVersionInfo - AWS Systems Manager

AssociationVersionInfo

Information about the association version.

Contents

ApplyOnlyAtCronInterval

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 isn't supported for rate expressions.

Type: Boolean

Required: No

AssociationId

The ID created by the system when the association was created.

Type: String

Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Required: No

AssociationName

The name specified for the association version when the association version was created.

Type: String

Pattern: ^[a-zA-Z0-9_\-.]{3,128}$

Required: No

AssociationVersion

The association version.

Type: String

Pattern: ([$]LATEST)|([1-9][0-9]*)

Required: No

CalendarNames

The names or Amazon Resource Names (ARNs) of the Change Calendar type documents your associations are gated under. The associations for this version only run when that Change Calendar is open. For more information, see AWS Systems Manager Change Calendar.

Type: Array of strings

Required: No

ComplianceSeverity

The severity level that is assigned to the association.

Type: String

Valid Values: CRITICAL | HIGH | MEDIUM | LOW | UNSPECIFIED

Required: No

CreatedDate

The date the association version was created.

Type: Timestamp

Required: No

DocumentVersion

The version of an AWS Systems Manager document (SSM document) used when the association version was created.

Type: String

Pattern: ([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)

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 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.

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 specified when the association was created.

Type: String

Pattern: ^[a-zA-Z0-9_\-.:/]{3,128}$

Required: No

OutputLocation

The location in Amazon S3 specified for the association when the association version was created.

Type: InstanceAssociationOutputLocation object

Required: No

Parameters

Parameters specified when the association version was created.

Type: String to array of strings map

Required: No

ScheduleExpression

The cron or rate schedule specified for the association when the association version was created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

SyncCompliance

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 operation. In this case, compliance data isn't managed by State Manager, a capability of AWS Systems Manager. It is managed by your direct call to the PutComplianceItems API operation.

By default, all associations use AUTO mode.

Type: String

Valid Values: AUTO | MANUAL

Required: No

TargetLocations

The combination of AWS Regions and AWS accounts where you wanted to run the association when this association version was created.

Type: Array of TargetLocation objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

Targets

The targets specified for the association when the association version was created.

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: