AWS Systems Manager
User Guide

Create an Association (Console)

This section describes how to create a State Manager association by using the AWS Systems Manager console. To view an example of how to create an association by using the AWS CLI, see Automatically Update SSM Agent (CLI).

To create a State Manager association (Console)

  1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems-manager/.

  2. In the navigation pane, choose State Manager, and then choose Create association.

  3. In the Name field, specify a name. This is optional, but recommended. A name can help you understand the purpose of the association when you created it. For example, you could specify Automatically_update_AWSPVDrivers_on_us-west-2_instances for an association with that purpose. Spaces aren't allowed in the name.

  4. In the Command document list, choose the option beside a document name. Use the Search bar to filter on Document type:Equal:Command documents. You can use the numbers to the right of the Search bar to view more Command documents.

    Note

    You can view information about a document by choosing the document name.

  5. In the Parameters section, specify the required input parameters.

  6. In the Targets section, choose either Specifying tags or Manually Selecting Instance. If you choose to target resources by using tags, then enter a tag key and a tag value in the fields provided. For more information about using targets, see Using Targets and Rate Controls with State Manager Associations.

  7. In the Specify schedule section, choose either On Schedule or No schedule. If you choose On Schedule, then use the buttons provided to create a cron or rate schedule for the association.

  8. In the Advanced options section:

    • In Compliance severity, choose a severity level for the association. Compliance reporting will indicate whether the association state is compliant or non-compliant, along with the severity level you indicate here. For more information, see About State Manager Association Compliance.

  9. In the Rate control section, configure options for executing State Manager associations across of fleet of managed instances. For more information about these options, see Using Targets and Rate Controls with State Manager Associations.

    In the Concurrency section, choose an option:

    • Choose targets to enter an absolute number of targets that can execute the association simultaneously.

    • Choose percentage to enter a percentage of the target set that can execute the association simultaneously.

    In the Error threshold section, choose an option:

    • Choose errors to enter an absolute number of errors allowed before State Manager stops executing associations on additional targets.

    • Choose percentage to enter a percentage of errors allowed before State Manager stops executing associations on additional targets.

  10. In the Output options section, choose Enable writing output to S3 if you want to write the output of the command to create the associations to an Amazon S3 bucket.

  11. Choose Create Association.

State Manager creates and immediately executes the association on the specified instances or targets. After the initial execution, the association runs in intervals according to the schedule that you defined and according to the following rules:

  • Associations are only executed on instances that are online when the interval starts. Offline instances are skipped.

  • State Manager attempts to execute the association on all configured instances during an interval.

  • If an association is not executed during an interval (because, for example, a concurrency value limited the number of instances that could process the association at one time), then State Manager attempts to execute the association during the next interval.

  • State Manager records history for all skipped intervals. You can view the history on the Execution History tab.