public static interface InstancePatchState.Builder extends SdkPojo, CopyableBuilder<InstancePatchState.Builder,InstancePatchState>
Modifier and Type | Method and Description |
---|---|
InstancePatchState.Builder |
baselineId(String baselineId)
The ID of the patch baseline used to patch the instance.
|
InstancePatchState.Builder |
failedCount(Integer failedCount)
The number of patches from the patch baseline that were attempted to be installed during the last patching
operation, but failed to install.
|
InstancePatchState.Builder |
installedCount(Integer installedCount)
The number of patches from the patch baseline that are installed on the instance.
|
InstancePatchState.Builder |
installedOtherCount(Integer installedOtherCount)
The number of patches not specified in the patch baseline that are installed on the instance.
|
InstancePatchState.Builder |
installedPendingRebootCount(Integer installedPendingRebootCount)
The number of patches installed by Patch Manager since the last time the instance was rebooted.
|
InstancePatchState.Builder |
installedRejectedCount(Integer installedRejectedCount)
The number of patches installed on an instance that are specified in a
RejectedPatches list. |
InstancePatchState.Builder |
installOverrideList(String installOverrideList)
An https URL or an Amazon S3 path-style URL to a list of patches to be installed.
|
InstancePatchState.Builder |
instanceId(String instanceId)
The ID of the managed instance the high-level patch compliance information was collected for.
|
InstancePatchState.Builder |
lastNoRebootInstallOperationTime(Instant lastNoRebootInstallOperationTime)
The time of the last attempt to patch the instance with
NoReboot specified as the reboot option. |
InstancePatchState.Builder |
missingCount(Integer missingCount)
The number of patches from the patch baseline that are applicable for the instance but aren't currently
installed.
|
InstancePatchState.Builder |
notApplicableCount(Integer notApplicableCount)
The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't
installed on the instance.
|
InstancePatchState.Builder |
operation(PatchOperationType operation)
The type of patching operation that was performed:
SCAN (assess patch compliance state) or
INSTALL (install missing patches). |
InstancePatchState.Builder |
operation(String operation)
The type of patching operation that was performed:
SCAN (assess patch compliance state) or
INSTALL (install missing patches). |
InstancePatchState.Builder |
operationEndTime(Instant operationEndTime)
The time the most recent patching operation completed on the instance.
|
InstancePatchState.Builder |
operationStartTime(Instant operationStartTime)
The time the most recent patching operation was started on the instance.
|
InstancePatchState.Builder |
ownerInformation(String ownerInformation)
Placeholder information.
|
InstancePatchState.Builder |
patchGroup(String patchGroup)
The name of the patch group the managed instance belongs to.
|
InstancePatchState.Builder |
rebootOption(RebootOption rebootOption)
Indicates the reboot option specified in the patch baseline.
|
InstancePatchState.Builder |
rebootOption(String rebootOption)
Indicates the reboot option specified in the patch baseline.
|
InstancePatchState.Builder |
snapshotId(String snapshotId)
The ID of the patch baseline snapshot used during the patching operation when this compliance data was
collected.
|
InstancePatchState.Builder |
unreportedNotApplicableCount(Integer unreportedNotApplicableCount)
The number of patches beyond the supported limit of
NotApplicableCount that are not reported by
name to Systems Manager Inventory. |
equalsBySdkFields, sdkFields
copy
applyMutation, build
InstancePatchState.Builder instanceId(String instanceId)
The ID of the managed instance the high-level patch compliance information was collected for.
instanceId
- The ID of the managed instance the high-level patch compliance information was collected for.InstancePatchState.Builder patchGroup(String patchGroup)
The name of the patch group the managed instance belongs to.
patchGroup
- The name of the patch group the managed instance belongs to.InstancePatchState.Builder baselineId(String baselineId)
The ID of the patch baseline used to patch the instance.
baselineId
- The ID of the patch baseline used to patch the instance.InstancePatchState.Builder snapshotId(String snapshotId)
The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
snapshotId
- The ID of the patch baseline snapshot used during the patching operation when this compliance data was
collected.InstancePatchState.Builder installOverrideList(String installOverrideList)
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.
installOverrideList
- 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.
InstancePatchState.Builder ownerInformation(String ownerInformation)
Placeholder information. This field will always be empty in the current release of the service.
ownerInformation
- Placeholder information. This field will always be empty in the current release of the service.InstancePatchState.Builder installedCount(Integer installedCount)
The number of patches from the patch baseline that are installed on the instance.
installedCount
- The number of patches from the patch baseline that are installed on the instance.InstancePatchState.Builder installedOtherCount(Integer installedOtherCount)
The number of patches not specified in the patch baseline that are installed on the instance.
installedOtherCount
- The number of patches not specified in the patch baseline that are installed on the instance.InstancePatchState.Builder installedPendingRebootCount(Integer installedPendingRebootCount)
The number of patches installed by Patch Manager since the last time the instance was rebooted.
installedPendingRebootCount
- The number of patches installed by Patch Manager since the last time the instance was rebooted.InstancePatchState.Builder installedRejectedCount(Integer installedRejectedCount)
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).
installedRejectedCount
- 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).
InstancePatchState.Builder missingCount(Integer missingCount)
The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.
missingCount
- The number of patches from the patch baseline that are applicable for the instance but aren't
currently installed.InstancePatchState.Builder failedCount(Integer failedCount)
The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
failedCount
- The number of patches from the patch baseline that were attempted to be installed during the last
patching operation, but failed to install.InstancePatchState.Builder unreportedNotApplicableCount(Integer unreportedNotApplicableCount)
The number of patches beyond the supported limit of NotApplicableCount
that are not reported by
name to Systems Manager Inventory.
unreportedNotApplicableCount
- The number of patches beyond the supported limit of NotApplicableCount
that are not
reported by name to Systems Manager Inventory.InstancePatchState.Builder notApplicableCount(Integer notApplicableCount)
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
.
notApplicableCount
- 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
.InstancePatchState.Builder operationStartTime(Instant operationStartTime)
The time the most recent patching operation was started on the instance.
operationStartTime
- The time the most recent patching operation was started on the instance.InstancePatchState.Builder operationEndTime(Instant operationEndTime)
The time the most recent patching operation completed on the instance.
operationEndTime
- The time the most recent patching operation completed on the instance.InstancePatchState.Builder operation(String operation)
The type of patching operation that was performed: SCAN
(assess patch compliance state) or
INSTALL
(install missing patches).
operation
- The type of patching operation that was performed: SCAN
(assess patch compliance state)
or INSTALL
(install missing patches).PatchOperationType
,
PatchOperationType
InstancePatchState.Builder operation(PatchOperationType operation)
The type of patching operation that was performed: SCAN
(assess patch compliance state) or
INSTALL
(install missing patches).
operation
- The type of patching operation that was performed: SCAN
(assess patch compliance state)
or INSTALL
(install missing patches).PatchOperationType
,
PatchOperationType
InstancePatchState.Builder lastNoRebootInstallOperationTime(Instant lastNoRebootInstallOperationTime)
The time of the last attempt to patch the instance with NoReboot
specified as the reboot option.
lastNoRebootInstallOperationTime
- The time of the last attempt to patch the instance with NoReboot
specified as the reboot
option.InstancePatchState.Builder rebootOption(String rebootOption)
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.
rebootOption
- 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.
RebootOption
,
RebootOption
InstancePatchState.Builder rebootOption(RebootOption rebootOption)
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.
rebootOption
- 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.
RebootOption
,
RebootOption
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.