class Amazonite::Ssm::DocumentDescription

• Amazonite::Ssm::DocumentDescription
• Reference
• Object

Overview

Describes an Amazon Web Services Systems Manager document (SSM document).

Included Modules

• JSON::Serializable

Defined in:

ssm/document_description.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(sha_1 : String | Nil = nil, hash : String | Nil = nil, hash_type : DocumentHashType | Nil = nil, name : String | Nil = nil, display_name : String | Nil = nil, version_name : String | Nil = nil, owner : String | Nil = nil, created_date : Time | Nil = nil, status : DocumentStatus | Nil = nil, status_information : String | Nil = nil, document_version : String | Nil = nil, description : String | Nil = nil, parameters : Array(DocumentParameter) | Nil = nil, platform_types : Array(PlatformType) | Nil = nil, document_type : DocumentType | Nil = nil, schema_version : String | Nil = nil, latest_version : String | Nil = nil, default_version : String | Nil = nil, document_format : DocumentFormat | Nil = nil, target_type : String | Nil = nil, tags : Array(Tag) | Nil = nil, attachments_information : Array(AttachmentInformation) | Nil = nil, requires : Array(DocumentRequires) | Nil = nil, author : String | Nil = nil, review_information : Array(ReviewInformation) | Nil = nil, approved_version : String | Nil = nil, pending_review_version : String | Nil = nil, review_status : ReviewStatus | Nil = nil, category : Array(String) | Nil = nil, category_enum : Array(String) | Nil = nil)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #approved_version : String | Nil

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

• #approved_version=(approved_version : String | Nil)

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

• #attachments_information : Array(AttachmentInformation) | Nil

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

• #attachments_information=(attachments_information : Array(AttachmentInformation) | Nil)

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

• #author : String | Nil

  The user in your organization who created the document.

• #author=(author : String | Nil)

  The user in your organization who created the document.

• #category : Array(String) | Nil

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

• #category=(category : Array(String) | Nil)

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

• #category_enum : Array(String) | Nil

  The value that identifies a document's category.

• #category_enum=(category_enum : Array(String) | Nil)

  The value that identifies a document's category.

• #created_date : Time | Nil

  The date when the document was created.

• #created_date=(created_date : Time | Nil)

  The date when the document was created.

• #default_version : String | Nil

  The default version.

• #default_version=(default_version : String | Nil)

  The default version.

• #description : String | Nil

  A description of the document.

• #description=(description : String | Nil)

  A description of the document.

• #display_name : String | Nil

  The friendly name of the SSM document.

• #display_name=(display_name : String | Nil)

  The friendly name of the SSM document.

• #document_format : DocumentFormat | Nil

  The document format, either JSON or YAML.

• #document_format=(document_format : DocumentFormat | Nil)

  The document format, either JSON or YAML.

• #document_type : DocumentType | Nil

  The type of document.

• #document_type=(document_type : DocumentType | Nil)

  The type of document.

• #document_version : String | Nil

  The document version.

• #document_version=(document_version : String | Nil)

  The document version.

• #hash(hasher)

  See Object#hash(hasher)

• #hash : String | Nil

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

• #hash=(hash : String | Nil)

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

• #hash_type : DocumentHashType | Nil

  The hash type of the document.

• #hash_type=(hash_type : DocumentHashType | Nil)

  The hash type of the document.

• #latest_version : String | Nil

  The latest version of the document.

• #latest_version=(latest_version : String | Nil)

  The latest version of the document.

• #name : String | Nil

  The name of the SSM document.

• #name=(name : String | Nil)

  The name of the SSM document.

• #owner : String | Nil

  The Amazon Web Services user that created the document.

• #owner=(owner : String | Nil)

  The Amazon Web Services user that created the document.

• #parameters : Array(DocumentParameter) | Nil

  A description of the parameters for a document.

• #parameters=(parameters : Array(DocumentParameter) | Nil)

  A description of the parameters for a document.

• #pending_review_version : String | Nil

  The version of the document that is currently under review.

• #pending_review_version=(pending_review_version : String | Nil)

  The version of the document that is currently under review.

• #platform_types : Array(PlatformType) | Nil

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

• #platform_types=(platform_types : Array(PlatformType) | Nil)

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

• #requires : Array(DocumentRequires) | Nil

  A list of SSM documents required by a document.

• #requires=(requires : Array(DocumentRequires) | Nil)

  A list of SSM documents required by a document.

• #review_information : Array(ReviewInformation) | Nil

  Details about the review of a document.

• #review_information=(review_information : Array(ReviewInformation) | Nil)

  Details about the review of a document.

• #review_status : ReviewStatus | Nil

  The current status of the review.

• #review_status=(review_status : ReviewStatus | Nil)

  The current status of the review.

• #schema_version : String | Nil

  The schema version.

• #schema_version=(schema_version : String | Nil)

  The schema version.

• #sha_1 : String | Nil

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

• #sha_1=(sha_1 : String | Nil)

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

• #status : DocumentStatus | Nil

  The status of the SSM document.

• #status=(status : DocumentStatus | Nil)

  The status of the SSM document.

• #status_information : String | Nil

  A message returned by Amazon Web Services Systems Manager that explains the Status value.

• #status_information=(status_information : String | Nil)

  A message returned by Amazon Web Services Systems Manager that explains the Status value.

• #tags : Array(Tag) | Nil

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

• #tags=(tags : Array(Tag) | Nil)

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

• #target_type : String | Nil

  The target type which defines the kinds of resources the document can run on.

• #target_type=(target_type : String | Nil)

  The target type which defines the kinds of resources the document can run on.

• #validate! : Nil
• #version_name : String | Nil

  The version of the artifact associated with the document.

• #version_name=(version_name : String | Nil)

  The version of the artifact associated with the document.

Constructor Detail

Instance Method Detail