class Amazonite::Ssm::GetDocumentResult

Included Modules

Defined in:

ssm/get_document_result.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(name : String | Nil = nil, created_date : Time | Nil = nil, display_name : String | Nil = nil, version_name : String | Nil = nil, document_version : String | Nil = nil, status : DocumentStatus | Nil = nil, status_information : String | Nil = nil, content : String | Nil = nil, document_type : DocumentType | Nil = nil, document_format : DocumentFormat | Nil = nil, requires : Array(DocumentRequires) | Nil = nil, attachments_content : Array(AttachmentContent) | Nil = nil, review_status : ReviewStatus | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def attachments_content : Array(AttachmentContent) | Nil #

A description of the document attachments, including names, locations, sizes, and so on.


[View source]
def attachments_content=(attachments_content : Array(AttachmentContent) | Nil) #

A description of the document attachments, including names, locations, sizes, and so on.


[View source]
def content : String | Nil #

The contents of the SSM document.


[View source]
def content=(content : String | Nil) #

The contents of the SSM document.


[View source]
def created_date : Time | Nil #

The date the SSM document was created.


[View source]
def created_date=(created_date : Time | Nil) #

The date the SSM document was created.


[View source]
def display_name : String | Nil #

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.


[View source]
def display_name=(display_name : String | Nil) #

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.


[View source]
def document_format : DocumentFormat | Nil #

The document format, either JSON or YAML.


[View source]
def document_format=(document_format : DocumentFormat | Nil) #

The document format, either JSON or YAML.


[View source]
def document_type : DocumentType | Nil #

The document type.


[View source]
def document_type=(document_type : DocumentType | Nil) #

The document type.


[View source]
def document_version : String | Nil #

The document version.


[View source]
def document_version=(document_version : String | Nil) #

The document version.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def name : String | Nil #

The name of the SSM document.


[View source]
def name=(name : String | Nil) #

The name of the SSM document.


[View source]
def requires : Array(DocumentRequires) | Nil #

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


[View source]
def requires=(requires : Array(DocumentRequires) | Nil) #

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


[View source]
def review_status : ReviewStatus | Nil #

The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of an SSM document can be in review, or PENDING, at a time.


[View source]
def review_status=(review_status : ReviewStatus | Nil) #

The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of an SSM document can be in review, or PENDING, at a time.


[View source]
def status : DocumentStatus | Nil #

The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.


[View source]
def status=(status : DocumentStatus | Nil) #

The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.


[View source]
def status_information : String | Nil #

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


[View source]
def status_information=(status_information : String | Nil) #

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


[View source]
def validate! : Nil #

[View source]
def version_name : String | Nil #

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.


[View source]
def version_name=(version_name : String | Nil) #

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.


[View source]