interface CfnPatchBaselineProps

Language	Type name
.NET	`Amazon.CDK.AWS.SSM.CfnPatchBaselineProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsssm#CfnPatchBaselineProps`
Java	`software.amazon.awscdk.services.ssm.CfnPatchBaselineProps`
Python	`aws_cdk.aws_ssm.CfnPatchBaselineProps`
TypeScript	`aws-cdk-lib` » `aws_ssm` » `CfnPatchBaselineProps`

Properties for defining a CfnPatchBaseline.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssm as ssm } from 'aws-cdk-lib';
const cfnPatchBaselineProps: ssm.CfnPatchBaselineProps = {
  name: 'name',

  // the properties below are optional
  approvalRules: {
    patchRules: [{
      approveAfterDays: 123,
      approveUntilDate: 'approveUntilDate',
      complianceLevel: 'complianceLevel',
      enableNonSecurity: false,
      patchFilterGroup: {
        patchFilters: [{
          key: 'key',
          values: ['values'],
        }],
      },
    }],
  },
  approvedPatches: ['approvedPatches'],
  approvedPatchesComplianceLevel: 'approvedPatchesComplianceLevel',
  approvedPatchesEnableNonSecurity: false,
  defaultBaseline: false,
  description: 'description',
  globalFilters: {
    patchFilters: [{
      key: 'key',
      values: ['values'],
    }],
  },
  operatingSystem: 'operatingSystem',
  patchGroups: ['patchGroups'],
  rejectedPatches: ['rejectedPatches'],
  rejectedPatchesAction: 'rejectedPatchesAction',
  sources: [{
    configuration: 'configuration',
    name: 'name',
    products: ['products'],
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
name	`string`	The name of the patch baseline.
approvalRules?	`IResolvable` `\|` `RuleGroupProperty`	A set of rules used to include patches in the baseline.
approvedPatches?	`string[]`	A list of explicitly approved patches for the baseline.
approvedPatchesComplianceLevel?	`string`	Defines the compliance level for approved patches.
approvedPatchesEnableNonSecurity?	`boolean \|` `IResolvable`	Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes.
defaultBaseline?	`boolean \|` `IResolvable`	Set the baseline as default baseline.
description?	`string`	A description of the patch baseline.
globalFilters?	`IResolvable` `\|` `PatchFilterGroupProperty`	A set of global filters used to include patches in the baseline.
operatingSystem?	`string`	Defines the operating system the patch baseline applies to.
patchGroups?	`string[]`	The name of the patch group to be registered with the patch baseline.
rejectedPatches?	`string[]`	A list of explicitly rejected patches for the baseline.
rejectedPatchesAction?	`string`	The action for Patch Manager to take on patches included in the `RejectedPackages` list.
sources?	`IResolvable` `\|` `IResolvable` `\|` `PatchSourceProperty[]`	Information about the patches to use to update the managed nodes, including target operating systems and source repositories.
tags?	`CfnTag[]`	Optional metadata that you assign to a resource.

name

Type: string

The name of the patch baseline.

approvalRules?

Type: IResolvable | RuleGroupProperty (optional)

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

approvedPatches?

Type: string[] (optional)

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 AWS Systems Manager User Guide .

approvedPatchesComplianceLevel?

Type: string (optional, default: "UNSPECIFIED")

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 .

approvedPatchesEnableNonSecurity?

Type: boolean | IResolvable (optional, default: false)

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.

defaultBaseline?

Type: boolean | IResolvable (optional, default: false)

Set the baseline as default baseline.

Only registering to default patch baseline is allowed.

description?

Type: string (optional)

A description of the patch baseline.

globalFilters?

Type: IResolvable | PatchFilterGroupProperty (optional)

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.

operatingSystem?

Type: string (optional, default: "WINDOWS")

Defines the operating system the patch baseline applies to.

The default value is WINDOWS .

patchGroups?

Type: string[] (optional)

The name of the patch group to be registered with the patch baseline.

rejectedPatches?

Type: string[] (optional)

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 AWS Systems Manager User Guide .

rejectedPatchesAction?

Type: string (optional, default: "ALLOW_AS_DEPENDENCY")

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. 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 .

sources?

Type: IResolvable | IResolvable | PatchSourceProperty[] (optional)

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?

Type: CfnTag[] (optional)

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.