AWS Fundamentals Logo
AWS Fundamentals
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

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

Filter:
PropertyTypeFlags
Name
string
Required
ApplyOnlyAtCronInterval
boolean
AssociationName
string
AutomationTargetParameterName
string
CalendarNames
Array<string>
ComplianceSeverity
string
DocumentVersion
string
InstanceId
string
MaxConcurrency
string
MaxErrors
string
OutputLocation
InstanceAssociationOutputLocation
Parameters
object
ScheduleExpression
string
ScheduleOffset
integer
SyncCompliance
string
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"

Required IAM Permissions

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

read

ssm:DescribeAssociationresource-groups:GetGroupQueryresource-groups:ListGroupsresource-groups:ListGroupResources

create

ec2:DescribeInstanceStatusiam:PassRoleiam:CreateServiceLinkedRolessm:CreateAssociationssm:DescribeAssociationssm:GetCalendarState

update

iam:PassRolessm:UpdateAssociationssm:GetCalendarState

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
Properties18
Required1
TaggingNot supported
Primary IDAssociationId

Supported Operations

ReadCreateUpdateListDelete

Related Resources

External Links