aws_ssm_document

account_id

Type: STRING

account_ids

Type: UNORDERED_LIST_STRING
Provider name: AccountIds
Description: 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

Type: UNORDERED_LIST_STRUCT
Provider name: AccountSharingInfoList
Description: A list of Amazon Web Services accounts where the current document is shared and the version shared with each account.

• account_id
  Type: STRING
  Provider name: AccountId
  Description: The Amazon Web Services account ID where the current document is shared.
  
• shared_document_version
  Type: STRING
  Provider name: SharedDocumentVersion
  Description: The version of the current document shared with the account.
  

approved_version

Type: STRING
Provider name: ApprovedVersion
Description: The version of the document currently approved for use in the organization.

attachments_information

Type: UNORDERED_LIST_STRUCT
Provider name: AttachmentsInformation
Description: Details about the document attachments, including names, locations, sizes, and so on.

• name
  Type: STRING
  Provider name: Name
  Description: The name of the attachment.
  

author

Type: STRING
Provider name: Author
Description: The user in your organization who created the document.

category

Type: UNORDERED_LIST_STRING
Provider name: Category
Description: The classification of a document to help you identify and categorize its use.

category_enum

Type: UNORDERED_LIST_STRING
Provider name: CategoryEnum
Description: The value that identifies a document’s category.

created_date

Type: TIMESTAMP
Provider name: CreatedDate
Description: The date when the document was created.

default_version

Type: STRING
Provider name: DefaultVersion
Description: The default version.

description

Type: STRING
Provider name: Description
Description: A description of the document.

document_arn

Type: STRING

document_format

Type: STRING
Provider name: DocumentFormat
Description: The document format, either JSON or YAML.

document_type

Type: STRING
Provider name: DocumentType
Description: The type of document.

document_version

Type: STRING
Provider name: DocumentVersion
Description: The document version.

hash

Type: STRING
Provider name: Hash
Description: The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.

hash_type

Type: STRING
Provider name: HashType
Description: The hash type of the document. Valid values include Sha256 or Sha1. Sha1 hashes have been deprecated.

latest_version

Type: STRING
Provider name: LatestVersion
Description: The latest version of the document.

name

Type: STRING
Provider name: Name
Description: The name of the SSM document.

owner

Type: STRING
Provider name: Owner
Description: The Amazon Web Services user that created the document.

parameters

Type: UNORDERED_LIST_STRUCT
Provider name: Parameters
Description: A description of the parameters for a document.

• default_value
  Type: STRING
  Provider name: DefaultValue
  Description: If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
  
• description
  Type: STRING
  Provider name: Description
  Description: A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
  
• name
  Type: STRING
  Provider name: Name
  Description: The name of the parameter.
  
• type
  Type: STRING
  Provider name: Type
  Description: The type of parameter. The type can be either String or StringList.
  

pending_review_version

Type: STRING
Provider name: PendingReviewVersion
Description: The version of the document that is currently under review.

platform_types

Type: UNORDERED_LIST_STRING
Provider name: PlatformTypes
Description: The list of operating system (OS) platforms compatible with this SSM document.

requires

Type: UNORDERED_LIST_STRUCT
Provider name: Requires
Description: A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

• name
  Type: STRING
  Provider name: Name
  Description: The name of the required SSM document. The name can be an Amazon Resource Name (ARN).
  
• require_type
  Type: STRING
  Provider name: RequireType
  Description: The document type of the required SSM document.
  
• version
  Type: STRING
  Provider name: Version
  Description: The document version required by the current document.
  
• version_name
  Type: STRING
  Provider name: VersionName
  Description: An optional field specifying the version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can’t be changed.
  

review_information

Type: UNORDERED_LIST_STRUCT
Provider name: ReviewInformation
Description: Details about the review of a document.

• reviewed_time
  Type: TIMESTAMP
  Provider name: ReviewedTime
  Description: The time that the reviewer took action on the document review request.
  
• reviewer
  Type: STRING
  Provider name: Reviewer
  Description: The reviewer assigned to take action on the document review request.
  
• status
  Type: STRING
  Provider name: Status
  Description: The current status of the document review request.
  

review_status

Type: STRING
Provider name: ReviewStatus
Description: The current status of the review.

schema_version

Type: STRING
Provider name: SchemaVersion
Description: The schema version.

sha1

Type: STRING
Provider name: Sha1
Description: The SHA1 hash of the document, which you can use for verification.

status

Type: STRING
Provider name: Status
Description: The status of the SSM document.

status_information

Type: STRING
Provider name: StatusInformation
Description: 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

Type: UNORDERED_LIST_STRING

target_type

Type: STRING
Provider name: TargetType
Description: 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

Type: STRING
Provider name: VersionName
Description: The version of the artifact associated with the document.