DocumentDescription

Gets and sets the property ApprovedVersion.

The version of the document currently approved for use in the organization.

Gets and sets the property AttachmentsInformation.

Details about the document attachments, including names, locations, sizes, and so on.

Gets and sets the property Author.

The user in your organization who created the document.

Gets and sets the property Category.

The classification of a document to help you identify and categorize its use.

Gets and sets the property CategoryEnum.

The value that identifies a document's category.

Gets and sets the property CreatedDate.

The date when the document was created.

Gets and sets the property DefaultVersion.

The default version.

Gets and sets the property Description.

A description of the document.

Gets and sets the property DisplayName.

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

Gets and sets the property DocumentFormat.

The document format, either JSON or YAML.

Gets and sets the property DocumentType.

The type of document.

Gets and sets the property DocumentVersion.

The document version.

Gets and sets the property Hash.

The Sha256 or Sha1 hash created by the system when the document was created.

Gets and sets the property HashType.

The hash type of the document. Valid values include Sha256 or Sha1.

Gets and sets the property LatestVersion.

The latest version of the document.

Gets and sets the property Name.

The name of the SSM document.

Gets and sets the property Owner.

The Amazon Web Services user that created the document.

Gets and sets the property Parameters.

A description of the parameters for a document.

Gets and sets the property PendingReviewVersion.

The version of the document that is currently under review.

Gets and sets the property PlatformTypes.

The list of operating system (OS) platforms compatible with this SSM document.

Gets and sets the property Requires.

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Gets and sets the property ReviewInformation.

Details about the review of a document.

Gets and sets the property ReviewStatus.

The current status of the review.

Gets and sets the property SchemaVersion.

The schema version.

Gets and sets the property Sha1.

The SHA1 hash of the document, which you can use for verification.

Gets and sets the property Status.

The status of the SSM document.

Gets and sets the property StatusInformation.

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."

Gets and sets the property Tags.

The tags, or metadata, that have been applied to the document.

Gets and sets the property TargetType.

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.

Gets and sets the property VersionName.

The version of the artifact associated with the document.