This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # AWS::SSM::PatchBaseline The `AWS::SSM::PatchBaseline` resource defines the basic information for an AWS Systems Manager patch baseline. A patch baseline defines which patches are approved for installation on your instances. For more information, see [CreatePatchBaseline](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreatePatchBaseline.html) in the *AWS Systems Manager API Reference*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::SSM::PatchBaseline", "Properties" : { "[ApprovalRules](#cfn-ssm-patchbaseline-approvalrules)" : RuleGroup, "[ApprovedPatches](#cfn-ssm-patchbaseline-approvedpatches)" : [ String, ... ], "[ApprovedPatchesComplianceLevel](#cfn-ssm-patchbaseline-approvedpatchescompliancelevel)" : String, "[ApprovedPatchesEnableNonSecurity](#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity)" : Boolean, "[AvailableSecurityUpdatesComplianceStatus](#cfn-ssm-patchbaseline-availablesecurityupdatescompliancestatus)" : String, "[DefaultBaseline](#cfn-ssm-patchbaseline-defaultbaseline)" : Boolean, "[Description](#cfn-ssm-patchbaseline-description)" : String, "[GlobalFilters](#cfn-ssm-patchbaseline-globalfilters)" : PatchFilterGroup, "[Name](#cfn-ssm-patchbaseline-name)" : String, "[OperatingSystem](#cfn-ssm-patchbaseline-operatingsystem)" : String, "[PatchGroups](#cfn-ssm-patchbaseline-patchgroups)" : [ String, ... ], "[RejectedPatches](#cfn-ssm-patchbaseline-rejectedpatches)" : [ String, ... ], "[RejectedPatchesAction](#cfn-ssm-patchbaseline-rejectedpatchesaction)" : String, "[Sources](#cfn-ssm-patchbaseline-sources)" : [ PatchSource, ... ], "[Tags](#cfn-ssm-patchbaseline-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::SSM::PatchBaseline Properties: [ApprovalRules](#cfn-ssm-patchbaseline-approvalrules): RuleGroup [ApprovedPatches](#cfn-ssm-patchbaseline-approvedpatches): - String [ApprovedPatchesComplianceLevel](#cfn-ssm-patchbaseline-approvedpatchescompliancelevel): String [ApprovedPatchesEnableNonSecurity](#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity): Boolean [AvailableSecurityUpdatesComplianceStatus](#cfn-ssm-patchbaseline-availablesecurityupdatescompliancestatus): String [DefaultBaseline](#cfn-ssm-patchbaseline-defaultbaseline): Boolean [Description](#cfn-ssm-patchbaseline-description): String [GlobalFilters](#cfn-ssm-patchbaseline-globalfilters): PatchFilterGroup [Name](#cfn-ssm-patchbaseline-name): String [OperatingSystem](#cfn-ssm-patchbaseline-operatingsystem): String [PatchGroups](#cfn-ssm-patchbaseline-patchgroups): - String [RejectedPatches](#cfn-ssm-patchbaseline-rejectedpatches): - String [RejectedPatchesAction](#cfn-ssm-patchbaseline-rejectedpatchesaction): String [Sources](#cfn-ssm-patchbaseline-sources): - PatchSource [Tags](#cfn-ssm-patchbaseline-tags): - Tag ``` ## Properties `ApprovalRules` A set of rules used to include patches in the baseline. *Required*: No *Type*: [RuleGroup](aws-properties-ssm-patchbaseline-rulegroup.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApprovedPatches` 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *AWS Systems Manager User Guide*. *Required*: No *Type*: Array of String *Minimum*: `1 | 0` *Maximum*: `100 | 50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApprovedPatchesComplianceLevel` 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`. *Required*: No *Type*: String *Allowed values*: `CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApprovedPatchesEnableNonSecurity` 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. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AvailableSecurityUpdatesComplianceStatus` 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. *Required*: No *Type*: String *Allowed values*: `NON_COMPLIANT | COMPLIANT` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DefaultBaseline` Indicates whether this is the default baseline. AWS Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description of the patch baseline. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GlobalFilters` A set of global filters used to include patches in the baseline. The `GlobalFilters` parameter can be configured only by using the AWS CLI or an AWS SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console. *Required*: No *Type*: [PatchFilterGroup](aws-properties-ssm-patchbaseline-patchfiltergroup.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the patch baseline. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_\-.]{3,128}$` *Minimum*: `3` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OperatingSystem` Defines the operating system the patch baseline applies to. The default value is `WINDOWS`. *Required*: No *Type*: String *Allowed values*: `WINDOWS | AMAZON_LINUX | AMAZON_LINUX_2 | AMAZON_LINUX_2022 | AMAZON_LINUX_2023 | UBUNTU | REDHAT_ENTERPRISE_LINUX | SUSE | CENTOS | ORACLE_LINUX | DEBIAN | MACOS | RASPBIAN | ROCKY_LINUX | ALMA_LINUX` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PatchGroups` The name of the patch group to be registered with the patch baseline. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RejectedPatches` 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](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html) in the *AWS Systems Manager User Guide*. *Required*: No *Type*: Array of String *Minimum*: `1 | 0` *Maximum*: `100 | 50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RejectedPatchesAction` The action for Patch Manager to take on patches included in the `RejectedPackages` list. ALLOW\$1AS\$1DEPENDENCY **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 `MISSING` for `SCAN` operations and as `FAILED` for `INSTALL` operations. *Required*: No *Type*: String *Allowed values*: `ALLOW_AS_DEPENDENCY | BLOCK` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Sources` Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only. *Required*: No *Type*: Array of [PatchSource](aws-properties-ssm-patchbaseline-patchsource.md) *Minimum*: `0` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` 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. *Required*: No *Type*: Array of [Tag](aws-properties-ssm-patchbaseline-tag.md) *Minimum*: `0` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the patch baseline ID, such as `pb-abcde1234567890yz`. **Note** The ID of the default patch baseline provided by AWS is an Amazon Resource Name (ARN), for example `arn:aws:ssm:us-west-2:123456789012:patchbaseline/abcde1234567890yz`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). ## Examples ### Create a patch baseline The following example creates a Systems Manager patch baseline that approves patches for Windows Server 2019 instances seven days after they are released by Microsoft. The patch baseline also approves patches for Active Directory seven days after they are released by Microsoft. #### ``` { "Resources": { "myPatchBaseline": { "Type": "AWS::SSM::PatchBaseline", "Properties": { "Name": "myPatchBaseline", "Description": "Baseline containing all updates approved for Windows instances", "OperatingSystem": "WINDOWS", "PatchGroups": [ "myPatchGroup" ], "ApprovalRules": { "PatchRules": [ { "PatchFilterGroup": { "PatchFilters": [ { "Values": [ "Critical", "Important", "Moderate" ], "Key": "MSRC_SEVERITY" }, { "Values": [ "SecurityUpdates", "CriticalUpdates" ], "Key": "CLASSIFICATION" }, { "Values": [ "WindowsServer2019" ], "Key": "PRODUCT" } ] }, "ApproveAfterDays": 7, "ComplianceLevel": "CRITICAL" }, { "PatchFilterGroup": { "PatchFilters": [ { "Values": [ "Critical", "Important", "Moderate" ], "Key": "MSRC_SEVERITY" }, { "Values": [ "*" ], "Key": "CLASSIFICATION" }, { "Values": [ "APPLICATION" ], "Key": "PATCH_SET" }, { "Values": [ "Active Directory Rights Management Services Client 2.0" ], "Key": "PRODUCT" }, { "Values": [ "Active Directory" ], "Key": "PRODUCT_FAMILY" } ] }, "ApproveAfterDays": 7, "ComplianceLevel": "CRITICAL" } ] } } } } } ``` #### YAML ``` --- Resources: myPatchBaseline: Type: AWS::SSM::PatchBaseline Properties: Name: myPatchBaseline Description: Baseline containing all updates approved for Windows instances OperatingSystem: WINDOWS PatchGroups: - myPatchGroup ApprovalRules: PatchRules: - PatchFilterGroup: PatchFilters: - Values: - Critical - Important - Moderate Key: MSRC_SEVERITY - Values: - SecurityUpdates - CriticalUpdates Key: CLASSIFICATION - Values: - WindowsServer2019 Key: PRODUCT ApproveAfterDays: 7 ComplianceLevel: CRITICAL - PatchFilterGroup: PatchFilters: - Values: - Critical - Important - Moderate Key: MSRC_SEVERITY - Values: - "*" Key: CLASSIFICATION - Values: - APPLICATION Key: PATCH_SET - Values: - Active Directory Rights Management Services Client 2.0 Key: PRODUCT - Values: - Active Directory Key: PRODUCT_FAMILY ApproveAfterDays: 7 ComplianceLevel: CRITICAL ``` ## See also + [CreatePatchBaseline](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreatePatchBaseline.html) in the *AWS Systems Manager API Reference*. # AWS::SSM::PatchBaseline PatchFilter The `PatchFilter` property type defines a patch filter for an AWS Systems Manager patch baseline. The `PatchFilters` property of the [PatchFilterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html) property type contains a list of `PatchFilter` property types. You can view lists of valid values for the patch properties by running the `DescribePatchProperties` command. For more information, see [DescribePatchProperties](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DescribePatchProperties.html) in the *AWS Systems Manager API Reference*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-ssm-patchbaseline-patchfilter-key)" : String, "[Values](#cfn-ssm-patchbaseline-patchfilter-values)" : [ String, ... ] } ``` ### YAML ``` [Key](#cfn-ssm-patchbaseline-patchfilter-key): String [Values](#cfn-ssm-patchbaseline-patchfilter-values): - String ``` ## Properties `Key` The key for the filter. For information about valid keys, see [PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html) in the *AWS Systems Manager API Reference*. *Required*: No *Type*: String *Allowed values*: `ADVISORY_ID | ARCH | BUGZILLA_ID | CLASSIFICATION | CVE_ID | EPOCH | MSRC_SEVERITY | NAME | PATCH_ID | PATCH_SET | PRIORITY | PRODUCT | PRODUCT_FAMILY | RELEASE | REPOSITORY | SECTION | SECURITY | SEVERITY | VERSION` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Values` The value for the filter key. For information about valid values for each key based on operating system type, see [PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html) in the *AWS Systems Manager API Reference*. *Required*: No *Type*: Array of String *Minimum*: `1 | 0` *Maximum*: `64 | 20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::SSM::PatchBaseline PatchFilterGroup The `PatchFilterGroup` property type specifies a set of patch filters for an AWS Systems Manager patch baseline, typically used for approval rules for a Systems Manager patch baseline. `PatchFilterGroup` is the property type for the `GlobalFilters` property of the [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource and the `PatchFilterGroup` property of the [Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html) property type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PatchFilters](#cfn-ssm-patchbaseline-patchfiltergroup-patchfilters)" : [ PatchFilter, ... ] } ``` ### YAML ``` [PatchFilters](#cfn-ssm-patchbaseline-patchfiltergroup-patchfilters): - PatchFilter ``` ## Properties `PatchFilters` The set of patch filters that make up the group. *Required*: No *Type*: Array of [PatchFilter](aws-properties-ssm-patchbaseline-patchfilter.md) *Minimum*: `0` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::SSM::PatchBaseline PatchSource `PatchSource` is the property type for the `Sources` resource of the [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource. The AWS CloudFormation`AWS::SSM::PatchSource` resource is used to provide information about the patches to use to update target instances, including target operating systems and source repository. Applies to Linux managed nodes only. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Configuration](#cfn-ssm-patchbaseline-patchsource-configuration)" : String, "[Name](#cfn-ssm-patchbaseline-patchsource-name)" : String, "[Products](#cfn-ssm-patchbaseline-patchsource-products)" : [ String, ... ] } ``` ### YAML ``` [Configuration](#cfn-ssm-patchbaseline-patchsource-configuration): String [Name](#cfn-ssm-patchbaseline-patchsource-name): String [Products](#cfn-ssm-patchbaseline-patchsource-products): - String ``` ## Properties `Configuration` The value of the repo configuration. **Example for yum repositories** `[main]` `name=MyCustomRepository` `baseurl=https://my-custom-repository` `enabled=1` For information about other options available for your yum repository configuration, see [dnf.conf(5)](https://man7.org/linux/man-pages/man5/dnf.conf.5.html) on the *man7.org* website. **Examples for Ubuntu Server and Debian Server** `deb http://security.ubuntu.com/ubuntu jammy main` `deb https://site.example.com/debian distribution component1 component2 component3` Repo information for Ubuntu Server repositories must be specifed in a single line. For more examples and information, see [jammy (5) sources.list.5.gz](https://manpages.ubuntu.com/manpages/jammy/man5/sources.list.5.html) on the *Ubuntu Server Manuals* website and [sources.list format](https://wiki.debian.org/SourcesList#sources.list_format) on the *Debian Wiki*. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name specified to identify the patch source. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-.]{3,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Products` The specific operating system versions a patch repository applies to, such as "Ubuntu16.04", "RedhatEnterpriseLinux7.2" or "Suse12.7". For lists of supported product values, see [PatchFilter](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchFilter.html) in the *AWS Systems Manager API Reference*. *Required*: No *Type*: Array of String *Minimum*: `1 | 0` *Maximum*: `128 | 20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::SSM::PatchBaseline Rule The `Rule` property type specifies an approval rule for a Systems Manager patch baseline. The `PatchRules` property of the [RuleGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html) property type contains a list of `Rule` property types. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ApproveAfterDays](#cfn-ssm-patchbaseline-rule-approveafterdays)" : Integer, "[ApproveUntilDate](#cfn-ssm-patchbaseline-rule-approveuntildate)" : String, "[ComplianceLevel](#cfn-ssm-patchbaseline-rule-compliancelevel)" : String, "[EnableNonSecurity](#cfn-ssm-patchbaseline-rule-enablenonsecurity)" : Boolean, "[PatchFilterGroup](#cfn-ssm-patchbaseline-rule-patchfiltergroup)" : PatchFilterGroup } ``` ### YAML ``` [ApproveAfterDays](#cfn-ssm-patchbaseline-rule-approveafterdays): Integer [ApproveUntilDate](#cfn-ssm-patchbaseline-rule-approveuntildate): String [ComplianceLevel](#cfn-ssm-patchbaseline-rule-compliancelevel): String [EnableNonSecurity](#cfn-ssm-patchbaseline-rule-enablenonsecurity): Boolean [PatchFilterGroup](#cfn-ssm-patchbaseline-rule-patchfiltergroup): PatchFilterGroup ``` ## Properties `ApproveAfterDays` The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of `7` means that patches are approved seven days after they are released. Patch Manager evaluates patch release dates using Coordinated Universal Time (UTC). If a patch is released at `2025-11-09T18:00:00Z` and `ApproveAfterDays` is set to `7`, the patch will be approved after `2025-11-16T18:00:00Z`. This parameter is marked as `Required: No`, but your request must include a value for either `ApproveAfterDays` or `ApproveUntilDate`. Not supported for Debian Server or Ubuntu Server. Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the **Windows Server** tab in the topic [How security patches are selected](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-selecting-patches.html) in the *AWS Systems Manager User Guide*. *Required*: No *Type*: Integer *Minimum*: `0` *Maximum*: `360` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApproveUntilDate` The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically. Enter dates in the format `YYYY-MM-DD`. For example, `2025-11-16`. Patch Manager evaluates patch release dates using Coordinated Universal Time (UTC). If you enter the date `2025-11-16`, patches released between `2025-11-16T00:00:00Z` and `2025-11-16T23:59:59Z` will be included in the approval. This parameter is marked as `Required: No`, but your request must include a value for either `ApproveUntilDate` or `ApproveAfterDays`. Not supported for Debian Server or Ubuntu Server. Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the **Windows Server** tab in the topic [How security patches are selected](https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-selecting-patches.html) in the *AWS Systems Manager User Guide*. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ComplianceLevel` A compliance severity level for all approved patches in a patch baseline. Valid compliance severity levels include the following: `UNSPECIFIED`, `CRITICAL`, `HIGH`, `MEDIUM`, `LOW`, and `INFORMATIONAL`. *Required*: No *Type*: String *Allowed values*: `CRITICAL | HIGH | INFORMATIONAL | LOW | MEDIUM | UNSPECIFIED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EnableNonSecurity` For managed nodes identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is `false`. Applies to Linux managed nodes only. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PatchFilterGroup` The patch filter group that defines the criteria for the rule. *Required*: No *Type*: [PatchFilterGroup](aws-properties-ssm-patchbaseline-patchfiltergroup.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## See also + [PatchRule](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PatchRule.html) in the *AWS Systems Manager API Reference*. # AWS::SSM::PatchBaseline RuleGroup The `RuleGroup` property type specifies a set of rules that define the approval rules for an AWS Systems Manager patch baseline. `RuleGroup` is the property type for the `ApprovalRules` property of the [AWS::SSM::PatchBaseline](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html) resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PatchRules](#cfn-ssm-patchbaseline-rulegroup-patchrules)" : [ Rule, ... ] } ``` ### YAML ``` [PatchRules](#cfn-ssm-patchbaseline-rulegroup-patchrules): - Rule ``` ## Properties `PatchRules` The rules that make up the rule group. *Required*: No *Type*: Array of [Rule](aws-properties-ssm-patchbaseline-rule.md) *Minimum*: `0` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::SSM::PatchBaseline Tag Metadata that you assign to your AWS resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In AWS Systems Manager, you can apply tags to Systems Manager documents (SSM documents), managed nodes, maintenance windows, parameters, patch baselines, OpsItems, and OpsMetadata. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-ssm-patchbaseline-tag-key)" : String, "[Value](#cfn-ssm-patchbaseline-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-ssm-patchbaseline-tag-key): String [Value](#cfn-ssm-patchbaseline-tag-value): String ``` ## Properties `Key` The name of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of the tag. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)