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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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.

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) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  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.

Returns:

  • (Integer) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  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 Amazon 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][1

in the *AWS Systems

Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-about-aws-runpatchbaseline.html

Returns:

  • (String) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end

#installed_count ⇒ Integer

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

Returns:

  • (Integer) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end

#installed_other_count ⇒ Integer

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

Returns:

  • (Integer) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end

#installed_pending_reboot_count ⇒ Integer

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

Returns:

  • (Integer) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end

#installed_rejected_count ⇒ Integer

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

<note markdown=“1”> If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).

</note>

Returns:

  • (Integer) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end

#instance_id ⇒ String

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

Returns:

  • (String) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  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.

Returns:

  • (Time) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  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.

Returns:

  • (Integer) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  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`.

Returns:

  • (Integer) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end

#operation ⇒ String

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

Returns:

  • (String) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end

#operation_end_time ⇒ Time

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

Returns:

  • (Time) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end

#operation_start_time ⇒ Time

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

Returns:

  • (Time) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end

#owner_information ⇒ String

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

Returns:

  • (String) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end

#patch_group ⇒ String

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

Returns:

  • (String) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end

#reboot_option ⇒ String

Indicates the reboot option specified in the patch baseline.

<note markdown=“1”> Reboot options apply to ‘Install` operations only. Reboots are not attempted for Patch Manager `Scan` operations.

</note>

  • 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.

Returns:

  • (String) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  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.

Returns:

  • (String) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  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.

Returns:

  • (Integer) 


8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
 
# File 'lib/aws-sdk-ssm/types.rb', line 8670

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)
  include Aws::Structure
end