Class: Aws::SSM::Types::InstancePatchState
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::InstancePatchState
- Defined in:
- gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb
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.
Constant Summary collapse
- SENSITIVE =
[:owner_information]
Instance Attribute Summary collapse
-
#baseline_id ⇒ 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.
-
#install_override_list ⇒ 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.
-
#installed_other_count ⇒ 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.
-
#installed_rejected_count ⇒ 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.
-
#last_no_reboot_install_operation_time ⇒ 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.
-
#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.
-
#operation ⇒ String
The type of patching operation that was performed:
SCAN
(assess patch compliance state) orINSTALL
(install missing patches). -
#operation_end_time ⇒ 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.
-
#owner_information ⇒ String
Placeholder information.
-
#patch_group ⇒ String
The name of the patch group the managed instance belongs to.
-
#reboot_option ⇒ 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.
-
#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.
Instance Attribute Details
#baseline_id ⇒ String
The ID of the patch baseline used to patch the instance.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#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.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#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.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#installed_count ⇒ Integer
The number of patches from the patch baseline that are installed on the instance.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#installed_other_count ⇒ Integer
The number of patches not specified in the patch baseline that are installed on the instance.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#installed_pending_reboot_count ⇒ Integer
The number of patches installed by Patch Manager since the last time the instance was rebooted.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#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.
ALLOW_AS_DEPENDENCY
is the specified option for
RejectedPatchesAction
, the value of InstalledRejectedCount
will
always be 0
(zero).
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#instance_id ⇒ String
The ID of the managed instance the high-level patch compliance information was collected for.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#last_no_reboot_install_operation_time ⇒ Time
The time of the last attempt to patch the instance with NoReboot
specified as the reboot option.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#missing_count ⇒ Integer
The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#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
.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#operation ⇒ String
The type of patching operation that was performed: SCAN
(assess
patch compliance state) or INSTALL
(install missing patches).
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#operation_end_time ⇒ Time
The time the most recent patching operation completed on the instance.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#operation_start_time ⇒ Time
The time the most recent patching operation was started on the instance.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#owner_information ⇒ String
Placeholder information. This field will always be empty in the current release of the service.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#patch_group ⇒ String
The name of the patch group the managed instance belongs to.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#reboot_option ⇒ String
Indicates the reboot option specified in the patch baseline.
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.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#snapshot_id ⇒ String
The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |
#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.
9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 9839 class InstancePatchState < Struct.new( :instance_id, :patch_group, :baseline_id, :snapshot_id, :install_override_list, :owner_information, :installed_count, :installed_other_count, :installed_pending_reboot_count, :installed_rejected_count, :missing_count, :failed_count, :unreported_not_applicable_count, :not_applicable_count, :operation_start_time, :operation_end_time, :operation, :last_no_reboot_install_operation_time, :reboot_option) SENSITIVE = [:owner_information] include Aws::Structure end |