AWS Fundamentals Logo
AWS Fundamentals
AWS::SSM::Document

SSM Document

The AWS::SSM::Document resource is an SSM document in AWS Systems Manager that defines the actions that Systems Manager performs, which can be used to set up and run commands on your instances.

Properties

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

Filter:
PropertyTypeFlags
Content
objectstring
Required
Attachments
Array<AttachmentsSource>
Write-only
DocumentFormat
string
DocumentType
string
Create-only
Name
string
Create-only
Requires
Array<DocumentRequires>
Tags
Array<Tag>
TargetType
string
UpdateMethod
string
Write-only
VersionName
string

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::Document

Resources:
  MyResource:
    Type: AWS::SSM::Document
    Properties:
      Content: "value"
      Tags:
        - Key: Environment
          Value: Production
      Name: !Ref "AWS::StackName"

Required IAM Permissions

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

read

ssm:DescribeDocumentssm:GetDocumentssm:ListTagsForResource

create

ssm:CreateDocumentssm:GetDocumentssm:AddTagsToResourcessm:ListTagsForResources3:GetObjectiam:PassRole

update

ssm:UpdateDocuments3:GetObjectssm:AddTagsToResourcessm:RemoveTagsFromResourcessm:ListTagsForResourceiam:PassRolessm:UpdateDocumentDefaultVersionssm:DescribeDocument

list

ssm:ListDocuments

delete

ssm:DeleteDocumentssm:GetDocument

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
Properties10
Required1
TaggingSupported
Primary IDName

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

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

NameDocumentType

Related Resources

External Links