AWS CloudFormation
User Guide (API Version 2010-05-15)

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 in the AWS Systems Manager API Reference.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::SSM::PatchBaseline", "Properties" : { "Name" : String, "OperatingSystem" : String, "Description" : String, "PatchGroups" : [ String, ... ], "ApprovalRules" : RuleGroup, "ApprovedPatches" : [ String, ... ], "ApprovedPatchesComplianceLevel" : String, "ApprovedPatchesEnableNonSecurity" : Boolean, "RejectedPatches" : [ String, ... ], "RejectedPatchesAction" : [ String ], "GlobalFilters" : PatchFilterGroup, "Sources" : PatchSource, "Tags" : [ Resource Tag, ... ] } }

YAML

Type: "AWS::SSM::PatchBaseline" Properties: Name: String OperatingSystem: String Description: String PatchGroups: - String ApprovalRules: RuleGroup ApprovedPatches: - String ApprovedPatchesComplianceLevel: String ApprovedPatchesEnableNonSecurity : Boolean RejectedPatches: - String RejectedPatchesAction : - String GlobalFilters: PatchFilterGroup Sources : PatchSource Tags: - Resource Tag

Properties

Name

The name of the patch baseline.

Required: Yes

Type: String

Update requires: No interruption

OperatingSystem

Defines the operating system that the patch baseline applies to. Supported operating systems include WINDOWS, AMAZON_LINUX, AMAZON_LINUX_2, UBUNTU, REDHAT_ENTERPRISE_LINUX, SUSE, and CENTOS. The default value is WINDOWS.

Required: No

Type: String

Update requires: Replacement

Description

A description of the patch baseline.

Required: No

Type: String

Update requires: No interruption

PatchGroups

The names of the patch groups to register with the patch baseline.

Required: No

Type: List of String values

Update requires: No interruption

ApprovalRules

A set of rules that are used to include patches in the baseline.

Required: No

Type: RuleGroup

Update requires: No interruption

ApprovedPatches

A list of explicitly approved patches for the baseline.

Required: No

Type: List of String values

Update requires: No interruption

ApprovedPatchesComplianceLevel

The compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. Valid compliance severity levels include the following: CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, and UNSPECIFIED. The default value is UNSPECIFIED.

Required: No

Type: String

Update requires: No interruption

ApprovedPatchesEnableNonSecurity

Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

Required: No

Type: Boolean

Update requires: No interruption

RejectedPatches

A list of explicitly rejected patches for the baseline.

Required: No

Type: List of String values

Update requires: No interruption

RejectedPatchesAction

The action for Patch Manager to take on patches included in the RejectedPackages list.

  • ALLOW_AS_DEPENDENCY: 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 InstalledOther. This is the default action if no option is specified.

  • BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.

Required: No

Type: List of String values

Update requires: No interruption

GlobalFilters

A set of global filters that are used to exclude patches from the baseline.

Required: No

Type: PatchFilterGroup

Update requires: No interruption

Sources

Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

Required: No

Type: Array of PatchSource objects

Update requires: No interruption

Tags

Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key–value pairs). 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: Resource Tag

Update requires: No interruption.

Return Values

Ref

When you pass the logical ID of an AWS::SSM::PatchBaseline resource to the intrinsic Ref function, the function returns the physical ID of the resource, such as pb-abcde1234567890yz.

Note

The ID of the default patch baseline provided by AWS is an ARN—for example arn:aws:ssm:us-west-2:123456789012:patchbaseline/abcde1234567890yz.

For more information about using the Ref function, see Ref.

See Also