AWS::SSM::Association

SSM Association

The AWS::SSM::Association resource associates an SSM document in AWS Systems Manager with EC2 instances that contain a configuration agent to process the document.

Properties

19 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
Name
string
Required
ApplyOnlyAtCronInterval
boolean
AssociationDispatchAssumeRole
string
AssociationName
string
AutomationTargetParameterName
string
CalendarNames
Array<string>
ComplianceSeverity
string
DocumentVersion
string
InstanceId
string
Create-only
MaxConcurrency
string
MaxErrors
string
OutputLocation
InstanceAssociationOutputLocation
Parameters
object
ScheduleExpression
string
ScheduleOffset
integer
SyncCompliance
string
Tags
Array<Tag>
Targets
Array<Target>
WaitForSuccessTimeoutSeconds
integer
Write-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
AssociationIdstringUnique identifier of the association.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::SSM::Association

Resources:
  MyResource:
    Type: AWS::SSM::Association
    Properties:
      Name: "my-name"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

ssm:DescribeAssociationssm:ListTagsForResourceresource-groups:GetGroupQueryresource-groups:ListGroupsresource-groups:ListGroupResources

create

ec2:DescribeInstanceStatusiam:PassRoleiam:CreateServiceLinkedRolessm:CreateAssociationssm:DescribeAssociationssm:GetCalendarStatessm:AddTagsToResourcessm:ListTagsForResource

update

iam:PassRolessm:UpdateAssociationssm:DescribeAssociationssm:GetCalendarStatessm:AddTagsToResourcessm:RemoveTagsFromResourcessm:ListTagsForResource

list

ssm:ListAssociations

delete

ssm:DeleteAssociation

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceSSM
Properties20
Required1
TaggingSupported
Primary IDAssociationId

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

InstanceId

Related Resources

External Links