Class InstancePatchState
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InstancePatchState.Builder,
InstancePatchState>
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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID of the patch baseline used to patch the managed node.static InstancePatchState.Builder
builder()
final Integer
The number of patches per node that are specified asCritical
for compliance reporting in the patch baseline aren't installed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
The number of patches from the patch baseline that are installed on the managed node.final Integer
The number of patches not specified in the patch baseline that are installed on the managed node.final Integer
The number of patches installed by Patch Manager since the last time the managed node was rebooted.final Integer
The number of patches installed on a managed node that are specified in aRejectedPatches
list.final String
An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed.final String
The ID of the managed node the high-level patch compliance information was collected for.final Instant
The time of the last attempt to patch the managed node withNoReboot
specified as the reboot option.final Integer
The number of patches from the patch baseline that are applicable for the managed node but aren't currently installed.final Integer
The number of patches from the patch baseline that aren't applicable for the managed node and therefore aren't installed on the node.final PatchOperationType
The type of patching operation that was performed: orfinal String
The type of patching operation that was performed: orfinal Instant
The time the most recent patching operation completed on the managed node.final Instant
The time the most recent patching operation was started on the managed node.final Integer
The number of patches per node that are specified as other thanCritical
orSecurity
but aren't compliant with the patch baseline.final String
Placeholder information.final String
The name of the patch group the managed node belongs to.final RebootOption
Indicates the reboot option specified in the patch baseline.final String
Indicates the reboot option specified in the patch baseline.final Integer
The number of patches per node that are specified asSecurity
in a patch advisory aren't installed.static Class
<? extends InstancePatchState.Builder> final String
The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The number of patches beyond the supported limit ofNotApplicableCount
that aren't reported by name to Inventory.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
instanceId
The ID of the managed node the high-level patch compliance information was collected for.
- Returns:
- The ID of the managed node the high-level patch compliance information was collected for.
-
patchGroup
The name of the patch group the managed node belongs to.
- Returns:
- The name of the patch group the managed node belongs to.
-
baselineId
The ID of the patch baseline used to patch the managed node.
- Returns:
- The ID of the patch baseline used to patch the managed node.
-
snapshotId
The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
- Returns:
- The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
-
installOverrideList
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 About theAWS-RunPatchBaseline SSM document
in the Amazon Web Services Systems Manager User Guide.- Returns:
- 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 About theAWS-RunPatchBaseline SSM document
in the Amazon Web Services Systems Manager User Guide.
-
ownerInformation
Placeholder information. This field will always be empty in the current release of the service.
- Returns:
- Placeholder information. This field will always be empty in the current release of the service.
-
installedCount
The number of patches from the patch baseline that are installed on the managed node.
- Returns:
- The number of patches from the patch baseline that are installed on the managed node.
-
installedOtherCount
The number of patches not specified in the patch baseline that are installed on the managed node.
- Returns:
- The number of patches not specified in the patch baseline that are installed on the managed node.
-
installedPendingRebootCount
The number of patches installed by Patch Manager since the last time the managed node was rebooted.
- Returns:
- The number of patches installed by Patch Manager since the last time the managed node was rebooted.
-
installedRejectedCount
The number of patches installed on a managed node that are specified in a
RejectedPatches
list. Patches with a status ofInstalledRejected
were typically installed before they were added to aRejectedPatches
list.If
ALLOW_AS_DEPENDENCY
is the specified option forRejectedPatchesAction
, the value ofInstalledRejectedCount
will always be0
(zero).- Returns:
- The number of patches installed on a managed node that are specified in a
RejectedPatches
list. Patches with a status ofInstalledRejected
were typically installed before they were added to aRejectedPatches
list.If
ALLOW_AS_DEPENDENCY
is the specified option forRejectedPatchesAction
, the value ofInstalledRejectedCount
will always be0
(zero).
-
missingCount
The number of patches from the patch baseline that are applicable for the managed node but aren't currently installed.
- Returns:
- The number of patches from the patch baseline that are applicable for the managed node but aren't currently installed.
-
failedCount
The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
- Returns:
- The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
-
unreportedNotApplicableCount
The number of patches beyond the supported limit of
NotApplicableCount
that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.- Returns:
- The number of patches beyond the supported limit of
NotApplicableCount
that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.
-
notApplicableCount
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
.- Returns:
- 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
.
-
operationStartTime
The time the most recent patching operation was started on the managed node.
- Returns:
- The time the most recent patching operation was started on the managed node.
-
operationEndTime
The time the most recent patching operation completed on the managed node.
- Returns:
- The time the most recent patching operation completed on the managed node.
-
operation
The type of patching operation that was performed: or
-
SCAN
assesses the patch compliance state. -
INSTALL
installs missing patches.
If the service returns an enum value that is not available in the current SDK version,
operation
will returnPatchOperationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperationAsString()
.- Returns:
- The type of patching operation that was performed: or
-
SCAN
assesses the patch compliance state. -
INSTALL
installs missing patches.
-
- See Also:
-
-
operationAsString
The type of patching operation that was performed: or
-
SCAN
assesses the patch compliance state. -
INSTALL
installs missing patches.
If the service returns an enum value that is not available in the current SDK version,
operation
will returnPatchOperationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperationAsString()
.- Returns:
- The type of patching operation that was performed: or
-
SCAN
assesses the patch compliance state. -
INSTALL
installs missing patches.
-
- See Also:
-
-
lastNoRebootInstallOperationTime
The time of the last attempt to patch the managed node with
NoReboot
specified as the reboot option.- Returns:
- The time of the last attempt to patch the managed node with
NoReboot
specified as the reboot option.
-
rebootOption
Indicates the reboot option specified in the patch baseline.
Reboot options apply to
Install
operations only. Reboots aren't attempted for Patch ManagerScan
operations.-
RebootIfNeeded
: Patch Manager tries to reboot the managed node if it installed any patches, or if any patches are detected with a status ofInstalledPendingReboot
. -
NoReboot
: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status ofInstalledPendingReboot
. These patches might not be in effect until a reboot is performed.
If the service returns an enum value that is not available in the current SDK version,
rebootOption
will returnRebootOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrebootOptionAsString()
.- Returns:
- Indicates the reboot option specified in the patch baseline.
Reboot options apply to
Install
operations only. Reboots aren't attempted for Patch ManagerScan
operations.-
RebootIfNeeded
: Patch Manager tries to reboot the managed node if it installed any patches, or if any patches are detected with a status ofInstalledPendingReboot
. -
NoReboot
: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status ofInstalledPendingReboot
. These patches might not be in effect until a reboot is performed.
-
- See Also:
-
-
rebootOptionAsString
Indicates the reboot option specified in the patch baseline.
Reboot options apply to
Install
operations only. Reboots aren't attempted for Patch ManagerScan
operations.-
RebootIfNeeded
: Patch Manager tries to reboot the managed node if it installed any patches, or if any patches are detected with a status ofInstalledPendingReboot
. -
NoReboot
: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status ofInstalledPendingReboot
. These patches might not be in effect until a reboot is performed.
If the service returns an enum value that is not available in the current SDK version,
rebootOption
will returnRebootOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrebootOptionAsString()
.- Returns:
- Indicates the reboot option specified in the patch baseline.
Reboot options apply to
Install
operations only. Reboots aren't attempted for Patch ManagerScan
operations.-
RebootIfNeeded
: Patch Manager tries to reboot the managed node if it installed any patches, or if any patches are detected with a status ofInstalledPendingReboot
. -
NoReboot
: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status ofInstalledPendingReboot
. These patches might not be in effect until a reboot is performed.
-
- See Also:
-
-
criticalNonCompliantCount
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 isNON_COMPLIANT
.- Returns:
- 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 isNON_COMPLIANT
.
-
securityNonCompliantCount
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 isNON_COMPLIANT
.- Returns:
- 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 isNON_COMPLIANT
.
-
otherNonCompliantCount
The number of patches per node that are specified as other than
Critical
orSecurity
but aren't compliant with the patch baseline. The status of these managed nodes isNON_COMPLIANT
.- Returns:
- The number of patches per node that are specified as other than
Critical
orSecurity
but aren't compliant with the patch baseline. The status of these managed nodes isNON_COMPLIANT
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<InstancePatchState.Builder,
InstancePatchState> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-