Documentation

Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.

See: newAssociation smart constructor.

Create a value of Association with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:associationId:Association', association_associationId - The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

$sel:associationName:Association', association_associationName - The association name.

$sel:associationVersion:Association', association_associationVersion - The association version.

$sel:documentVersion:Association', association_documentVersion - The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

$sel:instanceId:Association', association_instanceId - The managed node ID.

$sel:lastExecutionDate:Association', association_lastExecutionDate - The date on which the association was last run.

$sel:name:Association', association_name - The name of the SSM document.

$sel:overview:Association', association_overview - Information about the association.

$sel:scheduleExpression:Association', association_scheduleExpression - A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

$sel:scheduleOffset:Association', association_scheduleOffset - Number of days to wait after the scheduled day to run an association.

$sel:targetMaps:Association', association_targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

$sel:targets:Association', association_targets - The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

The association name.

The association version.

The version of the document used in the association. If you change a document version for a State Manager association, Systems Manager immediately runs the association unless you previously specifed the apply-only-at-cron-interval parameter.

State Manager doesn't support running associations that use a new version of a document if that document is shared from another account. State Manager always runs the default version of a document if shared from another account, even though the Systems Manager console shows that a new version was processed. If you want to run an association using a new version of a document shared form another account, you must set the document version to default.

The managed node ID.

The date on which the association was last run.

The name of the SSM document.

Information about the association.

A cron expression that specifies a schedule when the association runs. The schedule runs in Coordinated Universal Time (UTC).

Number of days to wait after the scheduled day to run an association.

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

The managed nodes targeted by the request to create an association. You can target all managed nodes in an Amazon Web Services account by specifying the InstanceIds key with a value of *.