Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data InstancePatchState = InstancePatchState' {
- criticalNonCompliantCount :: Maybe Int
- failedCount :: Maybe Int
- installOverrideList :: Maybe Text
- installedCount :: Maybe Int
- installedOtherCount :: Maybe Int
- installedPendingRebootCount :: Maybe Int
- installedRejectedCount :: Maybe Int
- lastNoRebootInstallOperationTime :: Maybe POSIX
- missingCount :: Maybe Int
- notApplicableCount :: Maybe Int
- otherNonCompliantCount :: Maybe Int
- ownerInformation :: Maybe (Sensitive Text)
- rebootOption :: Maybe RebootOption
- securityNonCompliantCount :: Maybe Int
- snapshotId :: Maybe Text
- unreportedNotApplicableCount :: Maybe Int
- instanceId :: Text
- patchGroup :: Text
- baselineId :: Text
- operationStartTime :: POSIX
- operationEndTime :: POSIX
- operation :: PatchOperationType
- newInstancePatchState :: Text -> Text -> Text -> UTCTime -> UTCTime -> PatchOperationType -> InstancePatchState
- instancePatchState_criticalNonCompliantCount :: Lens' InstancePatchState (Maybe Int)
- instancePatchState_failedCount :: Lens' InstancePatchState (Maybe Int)
- instancePatchState_installOverrideList :: Lens' InstancePatchState (Maybe Text)
- instancePatchState_installedCount :: Lens' InstancePatchState (Maybe Int)
- instancePatchState_installedOtherCount :: Lens' InstancePatchState (Maybe Int)
- instancePatchState_installedPendingRebootCount :: Lens' InstancePatchState (Maybe Int)
- instancePatchState_installedRejectedCount :: Lens' InstancePatchState (Maybe Int)
- instancePatchState_lastNoRebootInstallOperationTime :: Lens' InstancePatchState (Maybe UTCTime)
- instancePatchState_missingCount :: Lens' InstancePatchState (Maybe Int)
- instancePatchState_notApplicableCount :: Lens' InstancePatchState (Maybe Int)
- instancePatchState_otherNonCompliantCount :: Lens' InstancePatchState (Maybe Int)
- instancePatchState_ownerInformation :: Lens' InstancePatchState (Maybe Text)
- instancePatchState_rebootOption :: Lens' InstancePatchState (Maybe RebootOption)
- instancePatchState_securityNonCompliantCount :: Lens' InstancePatchState (Maybe Int)
- instancePatchState_snapshotId :: Lens' InstancePatchState (Maybe Text)
- instancePatchState_unreportedNotApplicableCount :: Lens' InstancePatchState (Maybe Int)
- instancePatchState_instanceId :: Lens' InstancePatchState Text
- instancePatchState_patchGroup :: Lens' InstancePatchState Text
- instancePatchState_baselineId :: Lens' InstancePatchState Text
- instancePatchState_operationStartTime :: Lens' InstancePatchState UTCTime
- instancePatchState_operationEndTime :: Lens' InstancePatchState UTCTime
- instancePatchState_operation :: Lens' InstancePatchState PatchOperationType
Documentation
data InstancePatchState Source #
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: newInstancePatchState
smart constructor.
InstancePatchState' | |
|
Instances
newInstancePatchState Source #
:: Text | |
-> Text | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> PatchOperationType | |
-> InstancePatchState |
Create a value of InstancePatchState
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:criticalNonCompliantCount:InstancePatchState'
, instancePatchState_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 is NON_COMPLIANT
.
$sel:failedCount:InstancePatchState'
, instancePatchState_failedCount
- The number of patches from the patch baseline that were attempted to be
installed during the last patching operation, but failed to install.
$sel:installOverrideList:InstancePatchState'
, instancePatchState_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 the AWS-RunPatchBaseline
SSM document in the Amazon Web Services Systems Manager User Guide.
$sel:installedCount:InstancePatchState'
, instancePatchState_installedCount
- The number of patches from the patch baseline that are installed on the
managed node.
$sel:installedOtherCount:InstancePatchState'
, instancePatchState_installedOtherCount
- The number of patches not specified in the patch baseline that are
installed on the managed node.
$sel:installedPendingRebootCount:InstancePatchState'
, instancePatchState_installedPendingRebootCount
- The number of patches installed by Patch Manager since the last time the
managed node was rebooted.
$sel:installedRejectedCount:InstancePatchState'
, instancePatchState_installedRejectedCount
- The number of patches installed on a managed node 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).
$sel:lastNoRebootInstallOperationTime:InstancePatchState'
, instancePatchState_lastNoRebootInstallOperationTime
- The time of the last attempt to patch the managed node with NoReboot
specified as the reboot option.
$sel:missingCount:InstancePatchState'
, instancePatchState_missingCount
- The number of patches from the patch baseline that are applicable for
the managed node but aren't currently installed.
$sel:notApplicableCount:InstancePatchState'
, instancePatchState_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
.
$sel:otherNonCompliantCount:InstancePatchState'
, instancePatchState_otherNonCompliantCount
- The number of patches per node that are specified as other than
Critical
or Security
but aren't compliant with the patch baseline.
The status of these managed nodes is NON_COMPLIANT
.
$sel:ownerInformation:InstancePatchState'
, instancePatchState_ownerInformation
- Placeholder information. This field will always be empty in the current
release of the service.
$sel:rebootOption:InstancePatchState'
, instancePatchState_rebootOption
- Indicates the reboot option specified in the patch baseline.
Reboot options apply to Install
operations only. Reboots aren't
attempted for Patch Manager Scan
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.
$sel:securityNonCompliantCount:InstancePatchState'
, instancePatchState_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 is
NON_COMPLIANT
.
$sel:snapshotId:InstancePatchState'
, instancePatchState_snapshotId
- The ID of the patch baseline snapshot used during the patching operation
when this compliance data was collected.
$sel:unreportedNotApplicableCount:InstancePatchState'
, instancePatchState_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.
$sel:instanceId:InstancePatchState'
, instancePatchState_instanceId
- The ID of the managed node the high-level patch compliance information
was collected for.
$sel:patchGroup:InstancePatchState'
, instancePatchState_patchGroup
- The name of the patch group the managed node belongs to.
$sel:baselineId:InstancePatchState'
, instancePatchState_baselineId
- The ID of the patch baseline used to patch the managed node.
$sel:operationStartTime:InstancePatchState'
, instancePatchState_operationStartTime
- The time the most recent patching operation was started on the managed
node.
$sel:operationEndTime:InstancePatchState'
, instancePatchState_operationEndTime
- The time the most recent patching operation completed on the managed
node.
$sel:operation:InstancePatchState'
, instancePatchState_operation
- The type of patching operation that was performed: or
SCAN
assesses the patch compliance state.INSTALL
installs missing patches.
instancePatchState_criticalNonCompliantCount :: Lens' InstancePatchState (Maybe Int) Source #
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 is NON_COMPLIANT
.
instancePatchState_failedCount :: Lens' InstancePatchState (Maybe Int) Source #
The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.
instancePatchState_installOverrideList :: Lens' InstancePatchState (Maybe Text) Source #
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 the AWS-RunPatchBaseline
SSM document in the Amazon Web Services Systems Manager User Guide.
instancePatchState_installedCount :: Lens' InstancePatchState (Maybe Int) Source #
The number of patches from the patch baseline that are installed on the managed node.
instancePatchState_installedOtherCount :: Lens' InstancePatchState (Maybe Int) Source #
The number of patches not specified in the patch baseline that are installed on the managed node.
instancePatchState_installedPendingRebootCount :: Lens' InstancePatchState (Maybe Int) Source #
The number of patches installed by Patch Manager since the last time the managed node was rebooted.
instancePatchState_installedRejectedCount :: Lens' InstancePatchState (Maybe Int) Source #
The number of patches installed on a managed node 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_lastNoRebootInstallOperationTime :: Lens' InstancePatchState (Maybe UTCTime) Source #
The time of the last attempt to patch the managed node with NoReboot
specified as the reboot option.
instancePatchState_missingCount :: Lens' InstancePatchState (Maybe Int) Source #
The number of patches from the patch baseline that are applicable for the managed node but aren't currently installed.
instancePatchState_notApplicableCount :: Lens' InstancePatchState (Maybe Int) Source #
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
.
instancePatchState_otherNonCompliantCount :: Lens' InstancePatchState (Maybe Int) Source #
The number of patches per node that are specified as other than
Critical
or Security
but aren't compliant with the patch baseline.
The status of these managed nodes is NON_COMPLIANT
.
instancePatchState_ownerInformation :: Lens' InstancePatchState (Maybe Text) Source #
Placeholder information. This field will always be empty in the current release of the service.
instancePatchState_rebootOption :: Lens' InstancePatchState (Maybe RebootOption) Source #
Indicates the reboot option specified in the patch baseline.
Reboot options apply to Install
operations only. Reboots aren't
attempted for Patch Manager Scan
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.
instancePatchState_securityNonCompliantCount :: Lens' InstancePatchState (Maybe Int) Source #
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 is
NON_COMPLIANT
.
instancePatchState_snapshotId :: Lens' InstancePatchState (Maybe Text) Source #
The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.
instancePatchState_unreportedNotApplicableCount :: Lens' InstancePatchState (Maybe Int) Source #
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.
instancePatchState_instanceId :: Lens' InstancePatchState Text Source #
The ID of the managed node the high-level patch compliance information was collected for.
instancePatchState_patchGroup :: Lens' InstancePatchState Text Source #
The name of the patch group the managed node belongs to.
instancePatchState_baselineId :: Lens' InstancePatchState Text Source #
The ID of the patch baseline used to patch the managed node.
instancePatchState_operationStartTime :: Lens' InstancePatchState UTCTime Source #
The time the most recent patching operation was started on the managed node.
instancePatchState_operationEndTime :: Lens' InstancePatchState UTCTime Source #
The time the most recent patching operation completed on the managed node.
instancePatchState_operation :: Lens' InstancePatchState PatchOperationType Source #
The type of patching operation that was performed: or
SCAN
assesses the patch compliance state.INSTALL
installs missing patches.