Systems Manager Document

Docs > DDSQL Reference > Data Directory > Systems Manager Document

AWS Systems Manager Document (SSM Document) defines actions that Systems Manager can perform on managed instances or AWS resources. It uses JSON or YAML to specify automation workflows, run commands, or configuration policies. These documents enable consistent, repeatable operations such as patching, software installation, or compliance checks across environments.

aws.ssm_document

Fields

ID	Type	Data Type	Description
_key	core	string
account_id	core	string
account_ids	core	array<string>	The account IDs that have permission to use this document. The ID can be either an Amazon Web Services account or All.
account_sharing_info_list	core	json	A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.
approved_version	core	string	The version of the document currently approved for use in the organization.
attachments_information	core	json	Details about the document attachments, including names, locations, sizes, and so on.
author	core	string	The user in your organization who created the document.
category	core	array<string>	The classification of a document to help you identify and categorize its use.
category_enum	core	array<string>	The value that identifies a document's category.
created_date	core	timestamp	The date when the document was created.
default_version	core	string	The default version.
description	core	string	A description of the document.
document_arn	core	string
document_format	core	string	The document format, either JSON or YAML.
document_type	core	string	The type of document.
document_version	core	string	The document version.
hash	core	string	The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.
hash_type	core	string	The hash type of the document. Valid values include Sha256 or Sha1. Sha1 hashes have been deprecated.
latest_version	core	string	The latest version of the document.
name	core	string	The name of the SSM document.
owner	core	string	The Amazon Web Services user that created the document.
parameters	core	json	A description of the parameters for a document.
pending_review_version	core	string	The version of the document that is currently under review.
platform_types	core	array<string>	The list of operating system (OS) platforms compatible with this SSM document.
requires	core	json	A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
review_information	core	json	Details about the review of a document.
review_status	core	string	The current status of the review.
schema_version	core	string	The schema version.
sha1	core	string	The SHA1 hash of the document, which you can use for verification.
status	core	string	The status of the SSM document.
status_information	core	string	A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
tags	core	hstore
target_type	core	string	The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
version_name	core	string	The version of the artifact associated with the document.