patch_group_states
Creates, updates, deletes, gets or lists a patch_group_states resource.
Overview
| Name | patch_group_states |
| Type | Resource |
| Id | aws.ssm.patch_group_states |
Fields
The following fields are returned by SELECT queries:
- describe_patch_group_state
| Name | Datatype | Description |
|---|---|---|
instances | integer | The number of managed nodes in the patch group. |
instances_with_available_security_updates | integer | The number of managed nodes for which security-related patches are available but not approved because because they didn't meet the patch baseline requirements. For example, an updated version of a patch might have been released before the specified auto-approval period was over. Applies to Windows Server managed nodes only. |
instances_with_critical_non_compliant_patches | integer | The number of managed nodes where patches 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. |
instances_with_failed_patches | integer | The number of managed nodes with patches from the patch baseline that failed to install. |
instances_with_installed_other_patches | integer | The number of managed nodes with patches installed that aren't defined in the patch baseline. |
instances_with_installed_patches | integer | The number of managed nodes with installed patches. |
instances_with_installed_pending_reboot_patches | integer | The number of managed nodes with patches installed by Patch Manager that haven't been rebooted after the patch installation. The status of these managed nodes is NON_COMPLIANT. |
instances_with_installed_rejected_patches | integer | The number of managed nodes with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list. If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero). |
instances_with_missing_patches | integer | The number of managed nodes with missing patches from the patch baseline. |
instances_with_not_applicable_patches | integer | The number of managed nodes with patches that aren't applicable. |
instances_with_other_non_compliant_patches | integer | The number of managed nodes with patches installed 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. |
instances_with_security_non_compliant_patches | integer | The number of managed nodes where patches 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. |
instances_with_unreported_not_applicable_patches | integer | The number of managed nodes with NotApplicable patches beyond the supported limit, which aren't reported by name to Inventory. Inventory is a tool in Amazon Web Services Systems Manager. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_patch_group_state | select | region | Returns high-level aggregated patch compliance state information for a patch group. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_patch_group_state
Returns high-level aggregated patch compliance state information for a patch group.
SELECT
instances,
instances_with_available_security_updates,
instances_with_critical_non_compliant_patches,
instances_with_failed_patches,
instances_with_installed_other_patches,
instances_with_installed_patches,
instances_with_installed_pending_reboot_patches,
instances_with_installed_rejected_patches,
instances_with_missing_patches,
instances_with_not_applicable_patches,
instances_with_other_non_compliant_patches,
instances_with_security_non_compliant_patches,
instances_with_unreported_not_applicable_patches
FROM aws.ssm.patch_group_states
WHERE region = '{{ region }}' -- required
;