You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SSM::Types::InstancePatchState

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Defines the high-level patch compliance state for a managed instance, 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 instance.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#baseline_id ⇒ String

The ID of the patch baseline used to patch the instance.

Returns:

  • (String) —

    The ID of the patch baseline used to patch the instance.

#failed_count ⇒ Integer

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

Returns:

  • (Integer) —

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

#install_override_list ⇒ String

An https URL or an 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 About the SSM document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.

Returns:

  • (String) —

    An https URL or an Amazon S3 path-style URL to a list of patches to be installed.

#installed_count ⇒ Integer

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

Returns:

  • (Integer) —

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

#installed_other_count ⇒ Integer

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

Returns:

  • (Integer) —

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

#installed_pending_reboot_count ⇒ Integer

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

Returns:

  • (Integer) —

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

#installed_rejected_count ⇒ Integer

The number of patches installed on an instance 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).

Returns:

  • (Integer) —

    The number of patches installed on an instance that are specified in a RejectedPatches list.

#instance_id ⇒ String

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

Returns:

  • (String) —

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

#last_no_reboot_install_operation_time ⇒ Time

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

Returns:

  • (Time) —

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

#missing_count ⇒ Integer

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

Returns:

  • (Integer) —

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

#not_applicable_count ⇒ Integer

The number of patches from the patch baseline that aren\'t applicable for the instance and therefore aren\'t installed on the instance. 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.

Returns:

  • (Integer) —

    The number of patches from the patch baseline that aren\'t applicable for the instance and therefore aren\'t installed on the instance.

#operation ⇒ String

The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).

Possible values:

  • Scan
  • Install

Returns:

  • (String) —

    The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).

#operation_end_time ⇒ Time

The time the most recent patching operation completed on the instance.

Returns:

  • (Time) —

    The time the most recent patching operation completed on the instance.

#operation_start_time ⇒ Time

The time the most recent patching operation was started on the instance.

Returns:

  • (Time) —

    The time the most recent patching operation was started on the instance.

#owner_information ⇒ String

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

Returns:

  • (String) —

    Placeholder information.

#patch_group ⇒ String

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

Returns:

  • (String) —

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

#reboot_option ⇒ String

Indicates the reboot option specified in the patch baseline.

Reboot options apply to Install operations only. Reboots are not attempted for Patch Manager Scan operations.

  • RebootIfNeeded: Patch Manager tries to reboot the instance 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.

    Possible values:

    • RebootIfNeeded
    • NoReboot

Returns:

  • (String) —

    Indicates the reboot option specified in the patch baseline.

#snapshot_id ⇒ String

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

Returns:

  • (String) —

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

#unreported_not_applicable_count ⇒ Integer

The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory.

Returns:

  • (Integer) —

    The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory.