class CfnPatchBaseline (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.SSM.CfnPatchBaseline`
Java	`software.amazon.awscdk.services.ssm.CfnPatchBaseline`
Python	`aws_cdk.aws_ssm.CfnPatchBaseline`
TypeScript	`@aws-cdk/aws-ssm` » `CfnPatchBaseline`

Implements IConstruct, IConstruct, IDependable, IInspectable

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ssm from '@aws-cdk/aws-ssm';
const cfnPatchBaseline = new ssm.CfnPatchBaseline(this, 'MyCfnPatchBaseline', {
  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,
  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',
  }],
});

Initializer

new CfnPatchBaseline(scope: Construct, id: string, props: CfnPatchBaselineProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnPatchBaselineProps — - resource properties.

Create a new AWS::SSM::PatchBaseline.

Construct Props

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.
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 About package name formats for approved and rejected patch lists in the AWS Systems Manager User Guide .

approvedPatchesComplianceLevel?

Type: string (optional)

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)

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.

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.

operatingSystem?

Type: string (optional)

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.

rejectedPatchesAction?

Type: string (optional)

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, aren't 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 .

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.

Properties

Name	Type	Description
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name of the patch baseline.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Optional metadata that you assign to a resource.
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.
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.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

The name of the patch baseline.

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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.

approvedPatchesComplianceLevel?

Type: string (optional)

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)

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.

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.

operatingSystem?

Type: string (optional)

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.

rejectedPatchesAction?

Type: string (optional)

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, aren't 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 .

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.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }