class Amazonite::Ssm::DocumentIdentifier

• Amazonite::Ssm::DocumentIdentifier
• Reference
• Object

Overview

Describes the name of a SSM document.

Included Modules

• JSON::Serializable

Defined in:

ssm/document_identifier.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(name : String | Nil = nil, created_date : Time | Nil = nil, display_name : String | Nil = nil, owner : String | Nil = nil, version_name : String | Nil = nil, platform_types : Array(PlatformType) | Nil = nil, document_version : String | Nil = nil, document_type : DocumentType | Nil = nil, schema_version : String | Nil = nil, document_format : DocumentFormat | Nil = nil, target_type : String | Nil = nil, tags : Array(Tag) | Nil = nil, requires : Array(DocumentRequires) | Nil = nil, review_status : ReviewStatus | Nil = nil, author : 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.

• #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.

• #created_date : Time | Nil

  The date the SSM document was created.

• #created_date=(created_date : Time | Nil)

  The date the SSM document was created.

• #display_name : String | Nil

  An optional field where you can specify a friendly name for the SSM document.

• #display_name=(display_name : String | Nil)

  An optional field where you can specify a friendly name for 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 document type.

• #document_type=(document_type : DocumentType | Nil)

  The document type.

• #document_version : String | Nil

  The document version.

• #document_version=(document_version : String | Nil)

  The document version.

• #hash(hasher)

  See Object#hash(hasher)

• #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.

• #platform_types : Array(PlatformType) | Nil

  The operating system platform.

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

  The operating system platform.

• #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_status : ReviewStatus | Nil

  The current status of a document review.

• #review_status=(review_status : ReviewStatus | Nil)

  The current status of a document review.

• #schema_version : String | Nil

  The schema version.

• #schema_version=(schema_version : String | Nil)

  The schema version.

• #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

  An optional field specifying the version of the artifact associated with the document.

• #version_name=(version_name : String | Nil)

  An optional field specifying the version of the artifact associated with the document.

Constructor Detail

Instance Method Detail