CreatePatchBaselineRequest
¶
Source code in docs_src/capo_ssm/types/create_patch_baseline_request.py
approval_rules
instance-attribute
¶
approval_rules: NotRequired[PatchRuleGroup]
A set of rules used to include patches in the baseline.
approved_patches
instance-attribute
¶
approved_patches: NotRequired[PatchIdList]
A list of explicitly approved patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
approved_patches_compliance_level
instance-attribute
¶
approved_patches_compliance_level: NotRequired[PatchComplianceLevel]
Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is UNSPECIFIED.
approved_patches_enable_non_security
instance-attribute
¶
approved_patches_enable_non_security: NotRequired[Boolean]
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is false. Applies to Linux managed nodes only.
available_security_updates_compliance_status
instance-attribute
¶
available_security_updates_compliance_status: NotRequired[PatchComplianceStatus]
Indicates the status you want to assign to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.
Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.
Supported for Windows Server managed nodes only.
client_token
instance-attribute
¶
client_token: NotRequired[ClientToken]
User-provided idempotency token.
description
instance-attribute
¶
description: NotRequired[BaselineDescription]
A description of the patch baseline.
global_filters
instance-attribute
¶
global_filters: NotRequired[PatchFilterGroup]
A set of global filters used to include patches in the baseline.
The GlobalFilters parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.
operating_system
instance-attribute
¶
operating_system: NotRequired[OperatingSystem]
Defines the operating system the patch baseline applies to. The default value is WINDOWS.
rejected_patches
instance-attribute
¶
rejected_patches: NotRequired[PatchIdList]
A list of explicitly rejected patches for the baseline.
For information about accepted formats for lists of approved patches and rejected patches, see Package name formats for approved and rejected patch lists in the Amazon Web Services Systems Manager User Guide.
rejected_patches_action
instance-attribute
¶
rejected_patches_action: NotRequired[PatchAction]
The action for Patch Manager to take on patches included in the RejectedPackages list.
- ALLOW_AS_DEPENDENCY
-
Linux and macOS: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as
INSTALLED_OTHER. This is the default action if no option is specified.Windows Server: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as
INSTALLED_OTHER. Any package not already installed on the node is skipped. This is the default action if no option is specified. - BLOCK
-
All OSs: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances.
State value assignment for patch compliance:
-
If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as
INSTALLED_REJECTED. -
If an update attempts to install a dependency package that is now rejected by the baseline, when previous versions of the package were not rejected, the package being updated is reported as
MISSINGforSCANoperations and asFAILEDforINSTALLoperations.
-
sources
instance-attribute
¶
sources: NotRequired[PatchSourceList]
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
tags
instance-attribute
¶
tags: NotRequired[TagList]
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key-value pairs:
-
Key=PatchSeverity,Value=Critical -
Key=OS,Value=Windows
To add tags to an existing patch baseline, use the AddTagsToResource operation.