Class CfnPatchBaseline
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ssm.CfnPatchBaseline
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-05T03:43:51.772Z")
@Stability(Stable)
public class CfnPatchBaseline
extends CfnResource
implements 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 .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.ssm.*; CfnPatchBaseline cfnPatchBaseline = CfnPatchBaseline.Builder.create(this, "MyCfnPatchBaseline") .name("name") // the properties below are optional .approvalRules(RuleGroupProperty.builder() .patchRules(List.of(RuleProperty.builder() .approveAfterDays(123) .approveUntilDate("approveUntilDate") .complianceLevel("complianceLevel") .enableNonSecurity(false) .patchFilterGroup(PatchFilterGroupProperty.builder() .patchFilters(List.of(PatchFilterProperty.builder() .key("key") .values(List.of("values")) .build())) .build()) .build())) .build()) .approvedPatches(List.of("approvedPatches")) .approvedPatchesComplianceLevel("approvedPatchesComplianceLevel") .approvedPatchesEnableNonSecurity(false) .defaultBaseline(false) .description("description") .globalFilters(PatchFilterGroupProperty.builder() .patchFilters(List.of(PatchFilterProperty.builder() .key("key") .values(List.of("values")) .build())) .build()) .operatingSystem("operatingSystem") .patchGroups(List.of("patchGroups")) .rejectedPatches(List.of("rejectedPatches")) .rejectedPatchesAction("rejectedPatchesAction") .sources(List.of(PatchSourceProperty.builder() .configuration("configuration") .name("name") .products(List.of("products")) .build())) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnPatchBaseline
.static interface
ThePatchFilterGroup
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.static interface
ThePatchFilter
property type defines a patch filter for an AWS Systems Manager patch baseline.static interface
static interface
TheRuleGroup
property type specifies a set of rules that define the approval rules for an AWS Systems Manager patch baseline.static interface
TheRule
property type specifies an approval rule for a Systems Manager patch baseline.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnPatchBaseline
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnPatchBaseline
(software.amazon.jsii.JsiiObjectRef objRef) CfnPatchBaseline
(software.constructs.Construct scope, String id, CfnPatchBaselineProps props) -
Method Summary
Modifier and TypeMethodDescriptionA set of rules used to include patches in the baseline.A list of explicitly approved patches for the baseline.Defines the compliance level for approved patches.Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes.The ID of the patch baseline.Set the baseline as default baseline.A description of the patch baseline.A set of global filters used to include patches in the baseline.getName()
The name of the patch baseline.Defines the operating system the patch baseline applies to.The name of the patch group to be registered with the patch baseline.A list of explicitly rejected patches for the baseline.The action for Patch Manager to take on patches included in theRejectedPackages
list.Information about the patches to use to update the managed nodes, including target operating systems and source repositories.getTags()
Tag Manager which manages the tags for this resource.Optional metadata that you assign to a resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setApprovalRules
(IResolvable value) A set of rules used to include patches in the baseline.void
A set of rules used to include patches in the baseline.void
setApprovedPatches
(List<String> value) A list of explicitly approved patches for the baseline.void
Defines the compliance level for approved patches.void
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes.void
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes.void
setDefaultBaseline
(Boolean value) Set the baseline as default baseline.void
setDefaultBaseline
(IResolvable value) Set the baseline as default baseline.void
setDescription
(String value) A description of the patch baseline.void
setGlobalFilters
(IResolvable value) A set of global filters used to include patches in the baseline.void
A set of global filters used to include patches in the baseline.void
The name of the patch baseline.void
setOperatingSystem
(String value) Defines the operating system the patch baseline applies to.void
setPatchGroups
(List<String> value) The name of the patch group to be registered with the patch baseline.void
setRejectedPatches
(List<String> value) A list of explicitly rejected patches for the baseline.void
setRejectedPatchesAction
(String value) The action for Patch Manager to take on patches included in theRejectedPackages
list.void
setSources
(List<Object> value) Information about the patches to use to update the managed nodes, including target operating systems and source repositories.void
setSources
(IResolvable value) Information about the patches to use to update the managed nodes, including target operating systems and source repositories.void
setTagsRaw
(List<CfnTag> value) Optional metadata that you assign to a resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnPatchBaseline
protected CfnPatchBaseline(software.amazon.jsii.JsiiObjectRef objRef) -
CfnPatchBaseline
protected CfnPatchBaseline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnPatchBaseline
@Stability(Stable) public CfnPatchBaseline(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPatchBaselineProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
The ID of the patch baseline. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getName
The name of the patch baseline. -
setName
The name of the patch baseline. -
getApprovalRules
A set of rules used to include patches in the baseline. -
setApprovalRules
A set of rules used to include patches in the baseline. -
setApprovalRules
A set of rules used to include patches in the baseline. -
getApprovedPatches
A list of explicitly approved patches for the baseline. -
setApprovedPatches
A list of explicitly approved patches for the baseline. -
getApprovedPatchesComplianceLevel
Defines the compliance level for approved patches. -
setApprovedPatchesComplianceLevel
Defines the compliance level for approved patches. -
getApprovedPatchesEnableNonSecurity
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. -
setApprovedPatchesEnableNonSecurity
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. -
setApprovedPatchesEnableNonSecurity
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. -
getDefaultBaseline
Set the baseline as default baseline. -
setDefaultBaseline
Set the baseline as default baseline. -
setDefaultBaseline
Set the baseline as default baseline. -
getDescription
A description of the patch baseline. -
setDescription
A description of the patch baseline. -
getGlobalFilters
A set of global filters used to include patches in the baseline. -
setGlobalFilters
A set of global filters used to include patches in the baseline. -
setGlobalFilters
@Stability(Stable) public void setGlobalFilters(@Nullable CfnPatchBaseline.PatchFilterGroupProperty value) A set of global filters used to include patches in the baseline. -
getOperatingSystem
Defines the operating system the patch baseline applies to. -
setOperatingSystem
Defines the operating system the patch baseline applies to. -
getPatchGroups
The name of the patch group to be registered with the patch baseline. -
setPatchGroups
The name of the patch group to be registered with the patch baseline. -
getRejectedPatches
A list of explicitly rejected patches for the baseline. -
setRejectedPatches
A list of explicitly rejected patches for the baseline. -
getRejectedPatchesAction
The action for Patch Manager to take on patches included in theRejectedPackages
list. -
setRejectedPatchesAction
The action for Patch Manager to take on patches included in theRejectedPackages
list. -
getSources
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. -
setSources
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. -
setSources
Information about the patches to use to update the managed nodes, including target operating systems and source repositories. -
getTagsRaw
Optional metadata that you assign to a resource. -
setTagsRaw
Optional metadata that you assign to a resource.
-