class Amazonite::Ssm::InstancePatchState

Overview

Defines the high-level patch compliance state for a managed node, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the managed node.

Included Modules

Defined in:

ssm/instance_patch_state.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(instance_id : String, patch_group : String, baseline_id : String, operation_start_time : Time, operation_end_time : Time, operation : PatchOperationType, snapshot_id : String | Nil = nil, install_override_list : String | Nil = nil, owner_information : String | Nil = nil, installed_count : Int32 | Nil = nil, installed_other_count : Int32 | Nil = nil, installed_pending_reboot_count : Int32 | Nil = nil, installed_rejected_count : Int32 | Nil = nil, missing_count : Int32 | Nil = nil, failed_count : Int32 | Nil = nil, unreported_not_applicable_count : Int32 | Nil = nil, not_applicable_count : Int32 | Nil = nil, available_security_update_count : Int32 | Nil = nil, last_no_reboot_install_operation_time : Time | Nil = nil, reboot_option : RebootOption | Nil = nil, critical_non_compliant_count : Int32 | Nil = nil, security_non_compliant_count : Int32 | Nil = nil, other_non_compliant_count : Int32 | Nil = nil) #

[View source]
def self.new(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 available_security_update_count : Int32 | Nil #

The number of security-related patches that are available but not approved because they didn't meet the patch baseline requirements. For example, an updated version of a patch might have been released before the specified auto-approval period was over.

Applies to Windows Server managed nodes only.


[View source]
def available_security_update_count=(available_security_update_count : Int32 | Nil) #

The number of security-related patches that are available but not approved because they didn't meet the patch baseline requirements. For example, an updated version of a patch might have been released before the specified auto-approval period was over.

Applies to Windows Server managed nodes only.


[View source]
def baseline_id : String #

The ID of the patch baseline used to patch the managed node.


[View source]
def baseline_id=(baseline_id : String) #

The ID of the patch baseline used to patch the managed node.


[View source]
def critical_non_compliant_count : Int32 | Nil #

The number of patches per node that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.


[View source]
def critical_non_compliant_count=(critical_non_compliant_count : Int32 | Nil) #

The number of patches per node that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.


[View source]
def failed_count : Int32 | Nil #

The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.


[View source]
def failed_count=(failed_count : Int32 | Nil) #

The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.


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

See Object#hash(hasher)


def install_override_list : String | Nil #

An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.

For more information about the InstallOverrideList parameter, see SSM Command document for patching: AWS-RunPatchBaseline in the Amazon Web Services Systems Manager User Guide.


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

An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.

For more information about the InstallOverrideList parameter, see SSM Command document for patching: AWS-RunPatchBaseline in the Amazon Web Services Systems Manager User Guide.


[View source]
def installed_count : Int32 | Nil #

The number of patches from the patch baseline that are installed on the managed node.


[View source]
def installed_count=(installed_count : Int32 | Nil) #

The number of patches from the patch baseline that are installed on the managed node.


[View source]
def installed_other_count : Int32 | Nil #

The number of patches not specified in the patch baseline that are installed on the managed node.


[View source]
def installed_other_count=(installed_other_count : Int32 | Nil) #

The number of patches not specified in the patch baseline that are installed on the managed node.


[View source]
def installed_pending_reboot_count : Int32 | Nil #

The number of patches installed by Patch Manager since the last time the managed node was rebooted.


[View source]
def installed_pending_reboot_count=(installed_pending_reboot_count : Int32 | Nil) #

The number of patches installed by Patch Manager since the last time the managed node was rebooted.


[View source]
def installed_rejected_count : Int32 | Nil #

The number of patches installed on a managed node that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.

If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).


[View source]
def installed_rejected_count=(installed_rejected_count : Int32 | Nil) #

The number of patches installed on a managed node that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.

If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).


[View source]
def instance_id : String #

The ID of the managed node the high-level patch compliance information was collected for.


[View source]
def instance_id=(instance_id : String) #

The ID of the managed node the high-level patch compliance information was collected for.


[View source]
def last_no_reboot_install_operation_time : Time | Nil #

The time of the last attempt to patch the managed node with NoReboot specified as the reboot option.


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

The time of the last attempt to patch the managed node with NoReboot specified as the reboot option.


[View source]
def missing_count : Int32 | Nil #

The number of patches from the patch baseline that are applicable for the managed node but aren't currently installed.


[View source]
def missing_count=(missing_count : Int32 | Nil) #

The number of patches from the patch baseline that are applicable for the managed node but aren't currently installed.


[View source]
def not_applicable_count : Int32 | Nil #

The number of patches from the patch baseline that aren't applicable for the managed node and therefore aren't installed on the node. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.


[View source]
def not_applicable_count=(not_applicable_count : Int32 | Nil) #

The number of patches from the patch baseline that aren't applicable for the managed node and therefore aren't installed on the node. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.


[View source]
def operation : PatchOperationType #

The type of patching operation that was performed: or

  • SCAN assesses the patch compliance state.

  • INSTALL installs missing patches.


[View source]
def operation=(operation : PatchOperationType) #

The type of patching operation that was performed: or

  • SCAN assesses the patch compliance state.

  • INSTALL installs missing patches.


[View source]
def operation_end_time : Time #

The time the most recent patching operation completed on the managed node.


[View source]
def operation_end_time=(operation_end_time : Time) #

The time the most recent patching operation completed on the managed node.


[View source]
def operation_start_time : Time #

The time the most recent patching operation was started on the managed node.


[View source]
def operation_start_time=(operation_start_time : Time) #

The time the most recent patching operation was started on the managed node.


[View source]
def other_non_compliant_count : Int32 | Nil #

The number of patches per node that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these managed nodes is NON_COMPLIANT.


[View source]
def other_non_compliant_count=(other_non_compliant_count : Int32 | Nil) #

The number of patches per node that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these managed nodes is NON_COMPLIANT.


[View source]
def owner_information : String | Nil #

Placeholder information. This field will always be empty in the current release of the service.


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

Placeholder information. This field will always be empty in the current release of the service.


[View source]
def patch_group : String #

The name of the patch group the managed node belongs to.


[View source]
def patch_group=(patch_group : String) #

The name of the patch group the managed node belongs to.


[View source]
def reboot_option : RebootOption | Nil #

Indicates the reboot option specified in the patch baseline.

Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations.

  • RebootIfNeeded: Patch Manager tries to reboot the managed node if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot.

  • NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in effect until a reboot is performed.


[View source]
def reboot_option=(reboot_option : RebootOption | Nil) #

Indicates the reboot option specified in the patch baseline.

Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations.

  • RebootIfNeeded: Patch Manager tries to reboot the managed node if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot.

  • NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in effect until a reboot is performed.


[View source]
def security_non_compliant_count : Int32 | Nil #

The number of patches per node that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.


[View source]
def security_non_compliant_count=(security_non_compliant_count : Int32 | Nil) #

The number of patches per node that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.


[View source]
def snapshot_id : String | Nil #

The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.


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

The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.


[View source]
def unreported_not_applicable_count : Int32 | Nil #

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager.


[View source]
def unreported_not_applicable_count=(unreported_not_applicable_count : Int32 | Nil) #

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager.


[View source]
def validate! : Nil #

[View source]