Package software.amazon.awscdk.services.ssm

Class CfnPatchBaseline.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.CfnPatchBaseline.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPatchBaseline>

Enclosing class:

CfnPatchBaseline

@Stability(Stable)
public static final class CfnPatchBaseline.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPatchBaseline>

A fluent builder for CfnPatchBaseline.

Method Summary

Modifier and Type	Method	Description
CfnPatchBaseline.Builder	approvalRules(IResolvable approvalRules)	A set of rules used to include patches in the baseline.
CfnPatchBaseline.Builder	approvalRules(CfnPatchBaseline.RuleGroupProperty approvalRules)	A set of rules used to include patches in the baseline.
CfnPatchBaseline.Builder	approvedPatches(List<String> approvedPatches)	A list of explicitly approved patches for the baseline.
CfnPatchBaseline.Builder	approvedPatchesComplianceLevel(String approvedPatchesComplianceLevel)	Defines the compliance level for approved patches.
CfnPatchBaseline.Builder	approvedPatchesEnableNonSecurity(Boolean approvedPatchesEnableNonSecurity)	Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes.
CfnPatchBaseline.Builder	approvedPatchesEnableNonSecurity(IResolvable approvedPatchesEnableNonSecurity)	Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes.
CfnPatchBaseline	build()
static CfnPatchBaseline.Builder	create(software.constructs.Construct scope, String id)
CfnPatchBaseline.Builder	defaultBaseline(Boolean defaultBaseline)	Set the baseline as default baseline.
CfnPatchBaseline.Builder	defaultBaseline(IResolvable defaultBaseline)	Set the baseline as default baseline.
CfnPatchBaseline.Builder	description(String description)	A description of the patch baseline.
CfnPatchBaseline.Builder	globalFilters(IResolvable globalFilters)	A set of global filters used to include patches in the baseline.
CfnPatchBaseline.Builder	globalFilters(CfnPatchBaseline.PatchFilterGroupProperty globalFilters)	A set of global filters used to include patches in the baseline.
CfnPatchBaseline.Builder	name(String name)	The name of the patch baseline.
CfnPatchBaseline.Builder	operatingSystem(String operatingSystem)	Defines the operating system the patch baseline applies to.
CfnPatchBaseline.Builder	patchGroups(List<String> patchGroups)	The name of the patch group to be registered with the patch baseline.
CfnPatchBaseline.Builder	rejectedPatches(List<String> rejectedPatches)	A list of explicitly rejected patches for the baseline.
CfnPatchBaseline.Builder	rejectedPatchesAction(String rejectedPatchesAction)	The action for Patch Manager to take on patches included in the RejectedPackages list.
CfnPatchBaseline.Builder	sources(List<? extends Object> sources)	Information about the patches to use to update the managed nodes, including target operating systems and source repositories.
CfnPatchBaseline.Builder	sources(IResolvable sources)	Information about the patches to use to update the managed nodes, including target operating systems and source repositories.
CfnPatchBaseline.Builder	tags(List<? extends CfnTag> tags)	Optional metadata that you assign to a resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnPatchBaseline.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnPatchBaseline.Builder.

name

@Stability(Stable)
public CfnPatchBaseline.Builder name(String name)

The name of the patch baseline.

Parameters:

name - The name of the patch baseline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-name

approvalRules

@Stability(Stable)
public CfnPatchBaseline.Builder approvalRules(IResolvable approvalRules)

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

Parameters:

approvalRules - A set of rules used to include patches in the baseline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules

approvalRules

@Stability(Stable)
public CfnPatchBaseline.Builder approvalRules(CfnPatchBaseline.RuleGroupProperty approvalRules)

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

Parameters:

approvalRules - A set of rules used to include patches in the baseline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules

approvedPatches

@Stability(Stable)
public CfnPatchBaseline.Builder approvedPatches(List<String> approvedPatches)

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 .

Parameters:

approvedPatches - A list of explicitly approved patches for the baseline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatches

approvedPatchesComplianceLevel

@Stability(Stable)
public CfnPatchBaseline.Builder approvedPatchesComplianceLevel(String approvedPatchesComplianceLevel)

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 .

Default: - "UNSPECIFIED"

Parameters:

approvedPatchesComplianceLevel - Defines the compliance level for approved patches. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchescompliancelevel

approvedPatchesEnableNonSecurity

@Stability(Stable)
public CfnPatchBaseline.Builder approvedPatchesEnableNonSecurity(Boolean approvedPatchesEnableNonSecurity)

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.

Default: - false

Parameters:

approvedPatchesEnableNonSecurity - Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity

approvedPatchesEnableNonSecurity

@Stability(Stable)
public CfnPatchBaseline.Builder approvedPatchesEnableNonSecurity(IResolvable approvedPatchesEnableNonSecurity)

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.

Default: - false

Parameters:

approvedPatchesEnableNonSecurity - Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity

defaultBaseline

@Stability(Stable)
public CfnPatchBaseline.Builder defaultBaseline(Boolean defaultBaseline)

Set the baseline as default baseline.

Only registering to default patch baseline is allowed.

Default: - false

Parameters:

defaultBaseline - Set the baseline as default baseline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-defaultbaseline

defaultBaseline

@Stability(Stable)
public CfnPatchBaseline.Builder defaultBaseline(IResolvable defaultBaseline)

Set the baseline as default baseline.

Only registering to default patch baseline is allowed.

Default: - false

Parameters:

defaultBaseline - Set the baseline as default baseline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-defaultbaseline

description

@Stability(Stable)
public CfnPatchBaseline.Builder description(String description)

A description of the patch baseline.

Parameters:

description - A description of the patch baseline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-description

globalFilters

@Stability(Stable)
public CfnPatchBaseline.Builder globalFilters(IResolvable globalFilters)

A set of global filters used to include patches in the baseline.

Parameters:

globalFilters - A set of global filters used to include patches in the baseline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters

globalFilters

@Stability(Stable)
public CfnPatchBaseline.Builder globalFilters(CfnPatchBaseline.PatchFilterGroupProperty globalFilters)

A set of global filters used to include patches in the baseline.

Parameters:

globalFilters - A set of global filters used to include patches in the baseline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters

operatingSystem

@Stability(Stable)
public CfnPatchBaseline.Builder operatingSystem(String operatingSystem)

Defines the operating system the patch baseline applies to.

The default value is WINDOWS .

Default: - "WINDOWS"

Parameters:

operatingSystem - Defines the operating system the patch baseline applies to. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-operatingsystem

patchGroups

@Stability(Stable)
public CfnPatchBaseline.Builder patchGroups(List<String> patchGroups)

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

Parameters:

patchGroups - The name of the patch group to be registered with the patch baseline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-patchgroups

rejectedPatches

@Stability(Stable)
public CfnPatchBaseline.Builder rejectedPatches(List<String> rejectedPatches)

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 .

Parameters:

rejectedPatches - A list of explicitly rejected patches for the baseline. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatches

rejectedPatchesAction

@Stability(Stable)
public CfnPatchBaseline.Builder rejectedPatchesAction(String rejectedPatchesAction)

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 .

Default: - "ALLOW_AS_DEPENDENCY"

Parameters:

rejectedPatchesAction - The action for Patch Manager to take on patches included in the RejectedPackages list. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatchesaction

sources

@Stability(Stable)
public CfnPatchBaseline.Builder sources(IResolvable sources)

Information about the patches to use to update the managed nodes, including target operating systems and source repositories.

Applies to Linux managed nodes only.

Parameters:

sources - Information about the patches to use to update the managed nodes, including target operating systems and source repositories. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources

sources

@Stability(Stable)
public CfnPatchBaseline.Builder sources(List<? extends Object> sources)

Information about the patches to use to update the managed nodes, including target operating systems and source repositories.

Applies to Linux managed nodes only.

Parameters:

sources - Information about the patches to use to update the managed nodes, including target operating systems and source repositories. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources

tags

@Stability(Stable)
public CfnPatchBaseline.Builder tags(List<? extends CfnTag> tags)

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.

Parameters:

tags - Optional metadata that you assign to a resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-tags

build

@Stability(Stable)
public CfnPatchBaseline build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPatchBaseline>

Returns:

a newly built instance of CfnPatchBaseline.