class Amazonite::Ssm::DocumentIdentifier

Overview

Describes the name of a SSM document.

Included Modules

Defined in:

ssm/document_identifier.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, 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) #

[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 author : String | Nil #

The user in your organization who created the document.


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

The user in your organization who created the 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 #

An optional field where you can specify a friendly name for 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) #

An optional field where you can specify a friendly name for 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 owner : String | Nil #

The Amazon Web Services user that created the document.


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

The Amazon Web Services user that created the document.


[View source]
def platform_types : Array(PlatformType) | Nil #

The operating system platform.


[View source]
def platform_types=(platform_types : Array(PlatformType) | Nil) #

The operating system platform.


[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 status of a document review.


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

The current status of a document review.


[View source]
def schema_version : String | Nil #

The schema version.


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

The schema version.


[View source]
def tags : Array(Tag) | Nil #

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


[View source]
def tags=(tags : Array(Tag) | Nil) #

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


[View source]
def target_type : String | Nil #

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.


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

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.


[View source]
def validate! : Nil #

[View source]
def version_name : String | Nil #

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.


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

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.


[View source]