class Amazonite::Ssm::ComplianceItem

Overview

Information about the compliance as defined by the resource type. For example, for a patch resource type, Items includes information about the PatchSeverity, Classification, and so on.

Included Modules

Defined in:

ssm/compliance_item.cr

Constructors

Instance Method Summary

Constructor Detail

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

[View source]
def self.new(compliance_type : String | Nil = nil, resource_type : String | Nil = nil, resource_id : String | Nil = nil, id : String | Nil = nil, title : String | Nil = nil, status : ComplianceStatus | Nil = nil, severity : ComplianceSeverity | Nil = nil, execution_summary : ComplianceExecutionSummary | Nil = nil, details : Hash(String, 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 compliance_type : String | Nil #

The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.


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

The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.


[View source]
def details : Hash(String, String) | Nil #

A "Key": "Value" tag combination for the compliance item.


[View source]
def details=(details : Hash(String, String) | Nil) #

A "Key": "Value" tag combination for the compliance item.


[View source]
def execution_summary : ComplianceExecutionSummary | Nil #

A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

For State Manager associations, the ExecutionTime value represents when the compliance status was captured and aggregated by the Systems Manager service, not necessarily when the underlying association was executed on the managed node. State Manager updates compliance status for all associations on an instance whenever any association executes, which means multiple associations may show the same execution time even if they were executed at different times.


[View source]
def execution_summary=(execution_summary : ComplianceExecutionSummary | Nil) #

A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

For State Manager associations, the ExecutionTime value represents when the compliance status was captured and aggregated by the Systems Manager service, not necessarily when the underlying association was executed on the managed node. State Manager updates compliance status for all associations on an instance whenever any association executes, which means multiple associations may show the same execution time even if they were executed at different times.


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

See Object#hash(hasher)


def id : String | Nil #

An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.


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

An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.


[View source]
def resource_id : String | Nil #

An ID for the resource. For a managed node, this is the node ID.


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

An ID for the resource. For a managed node, this is the node ID.


[View source]
def resource_type : String | Nil #

The type of resource. ManagedInstance is currently the only supported resource type.


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

The type of resource. ManagedInstance is currently the only supported resource type.


[View source]
def severity : ComplianceSeverity | Nil #

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.


[View source]
def severity=(severity : ComplianceSeverity | Nil) #

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.


[View source]
def status : ComplianceStatus | Nil #

The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).


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

The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).


[View source]
def title : String | Nil #

A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.


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

A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.


[View source]
def validate! : Nil #

[View source]