document

Gets an individual document resource

Overview

Name	document
Type	Resource
Description	document
Id	awscc.ssm.document

Fields

Name	Datatype	Description
content	object	The content for the Systems Manager document in JSON, YAML or String format.
attachments	array	A list of key and value pairs that describe attachments to a version of a document.
name	string	A name for the Systems Manager document.
version_name	string	An optional field specifying the version of the artifact you are creating with the document. This value is unique across all versions of a document, and cannot be changed.
document_type	string	The type of document to create.
document_format	string	Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.
target_type	string	Specify a target type to define the kinds of resources the document can run on.
tags	array	Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
requires	array	A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.
update_method	string	Update method - when set to 'Replace', the update will replace the existing document; when set to 'NewVersion', the update will create a new version.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
content,
attachments,
name,
version_name,
document_type,
document_format,
target_type,
tags,
requires,
update_method
FROM awscc.ssm.document
WHERE data__Identifier = '<Name>';

Permissions

To operate on the document resource, the following permissions are required:

Read

ssm:GetDocument,
ssm:ListTagsForResource

Update

ssm:UpdateDocument,
s3:GetObject,
ssm:AddTagsToResource,
ssm:RemoveTagsFromResource,
ssm:ListTagsForResource,
iam:PassRole,
ssm:UpdateDocumentDefaultVersion,
ssm:DescribeDocument

Delete

ssm:DeleteDocument,
ssm:GetDocument