class CfnPatchBaseline (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.SSM.CfnPatchBaseline |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsssm#CfnPatchBaseline |
Java | software.amazon.awscdk.services.ssm.CfnPatchBaseline |
Python | aws_cdk.aws_ssm.CfnPatchBaseline |
TypeScript | aws-cdk-lib » aws_ssm » CfnPatchBaseline |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
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 .
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html
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 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,
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',
}],
});
Initializer
new CfnPatchBaseline(scope: Construct, id: string, props: CfnPatchBaselineProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Patch Baseline Props
Construct Props
Name | Type | Description |
---|---|---|
name | string | The name of the patch baseline. |
approval | IResolvable | Rule | A set of rules used to include patches in the baseline. |
approved | string[] | A list of explicitly approved patches for the baseline. |
approved | string | Defines the compliance level for approved patches. |
approved | boolean | IResolvable | Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. |
default | boolean | IResolvable | Set the baseline as default baseline. |
description? | string | A description of the patch baseline. |
global | IResolvable | Patch | A set of global filters used to include patches in the baseline. |
operating | string | Defines the operating system the patch baseline applies to. |
patch | string[] | The name of the patch group to be registered with the patch baseline. |
rejected | string[] | A list of explicitly rejected patches for the baseline. |
rejected | string | The action for Patch Manager to take on patches included in the RejectedPackages list. |
sources? | IResolvable | IResolvable | Patch [] | Information about the patches to use to update the managed nodes, including target operating systems and source repositories. |
tags? | Cfn [] | Optional metadata that you assign to a resource. |
name
Type:
string
The name of the patch baseline.
approvalRules?
Type:
IResolvable
|
Rule
(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, 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
|
Patch
(optional)
A set of global filters used to include patches in the baseline.
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 About 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
: A package in theRejected
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 asInstalledOther
. This is the default action if no option is specified.- BLOCK : 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 InstalledRejected .
sources?
Type:
IResolvable
|
IResolvable
|
Patch
[]
(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:
Cfn
[]
(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 |
---|---|---|
attr | string | The ID of the patch baseline. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
name | string | The name of the patch baseline. |
node | Node | The tree node. |
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 | Tag | Tag Manager which manages the tags for this resource. |
approval | IResolvable | Rule | A set of rules used to include patches in the baseline. |
approved | string[] | A list of explicitly approved patches for the baseline. |
approved | string | Defines the compliance level for approved patches. |
approved | boolean | IResolvable | Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. |
default | boolean | IResolvable | Set the baseline as default baseline. |
description? | string | A description of the patch baseline. |
global | IResolvable | Patch | A set of global filters used to include patches in the baseline. |
operating | string | Defines the operating system the patch baseline applies to. |
patch | string[] | The name of the patch group to be registered with the patch baseline. |
rejected | string[] | A list of explicitly rejected patches for the baseline. |
rejected | string | The action for Patch Manager to take on patches included in the RejectedPackages list. |
sources? | IResolvable | IResolvable | Patch [] | Information about the patches to use to update the managed nodes, including target operating systems and source repositories. |
tags | Cfn [] | Optional metadata that you assign to a resource. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrId
Type:
string
The ID of the patch baseline.
cfnOptions
Type:
ICfn
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:
Node
The tree node.
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).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
approvalRules?
Type:
IResolvable
|
Rule
(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.
approvedPatchesEnableNonSecurity?
Type:
boolean |
IResolvable
(optional)
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes.
defaultBaseline?
Type:
boolean |
IResolvable
(optional)
Set the baseline as default baseline.
description?
Type:
string
(optional)
A description of the patch baseline.
globalFilters?
Type:
IResolvable
|
Patch
(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.
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.
sources?
Type:
IResolvable
|
IResolvable
|
Patch
[]
(optional)
Information about the patches to use to update the managed nodes, including target operating systems and source repositories.
tagsRaw?
Type:
Cfn
[]
(optional)
Optional metadata that you assign to a resource.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
DeletionOverride(path)
addpublic addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
Dependency(target)
addpublic addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
DependsOn(target)
addpublic addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
Metadata(key, value)
addpublic addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
See also: [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.](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.)
Override(path, value)
addpublic 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.
PropertyDeletionOverride(propertyPath)
addpublic 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.
PropertyOverride(propertyPath, value)
addpublic 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)
.
RemovalPolicy(policy?, options?)
applypublic applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
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
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
Att(attributeName, typeHint?)
getpublic getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
Metadata(key)
getpublic getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
See also: [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.](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.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
Dependencies()
obtainpublic obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
ResourceDependencies()
obtainpublic obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
LogicalId(newLogicalId)
overridepublic 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.
Dependency(target)
removepublic removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
Dependency(target, newTarget)
replacepublic replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
Properties(props)
protected renderprotected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }