CfnPatchBaselineProps

class aws_cdk.aws_ssm.CfnPatchBaselineProps(*, name, approval_rules=None, approved_patches=None, approved_patches_compliance_level=None, approved_patches_enable_non_security=None, description=None, global_filters=None, operating_system=None, patch_groups=None, rejected_patches=None, rejected_patches_action=None, sources=None, tags=None)

Bases: object

Properties for defining a CfnPatchBaseline.

Parameters
  • name (str) – The name of the patch baseline.

  • approval_rules (Union[IResolvable, RuleGroupProperty, None]) – A set of rules used to include patches in the baseline.

  • approved_patches (Optional[Sequence[str]]) – 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 .

  • approved_patches_compliance_level (Optional[str]) – 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 .

  • approved_patches_enable_non_security (Union[bool, IResolvable, None]) – 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 (Optional[str]) – A description of the patch baseline.

  • global_filters (Union[IResolvable, PatchFilterGroupProperty, None]) – A set of global filters used to include patches in the baseline.

  • operating_system (Optional[str]) – Defines the operating system the patch baseline applies to. The default value is WINDOWS .

  • patch_groups (Optional[Sequence[str]]) – The name of the patch group to be registered with the patch baseline.

  • rejected_patches (Optional[Sequence[str]]) –

    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 .

  • rejected_patches_action (Optional[str]) – 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 (Union[IResolvable, Sequence[Union[IResolvable, PatchSourceProperty]], None]) – 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 (Optional[Sequence[CfnTag]]) – 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.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ssm as ssm

cfn_patch_baseline_props = ssm.CfnPatchBaselineProps(
    name="name",

    # the properties below are optional
    approval_rules=ssm.CfnPatchBaseline.RuleGroupProperty(
        patch_rules=[ssm.CfnPatchBaseline.RuleProperty(
            approve_after_days=123,
            approve_until_date="approveUntilDate",
            compliance_level="complianceLevel",
            enable_non_security=False,
            patch_filter_group=ssm.CfnPatchBaseline.PatchFilterGroupProperty(
                patch_filters=[ssm.CfnPatchBaseline.PatchFilterProperty(
                    key="key",
                    values=["values"]
                )]
            )
        )]
    ),
    approved_patches=["approvedPatches"],
    approved_patches_compliance_level="approvedPatchesComplianceLevel",
    approved_patches_enable_non_security=False,
    description="description",
    global_filters=ssm.CfnPatchBaseline.PatchFilterGroupProperty(
        patch_filters=[ssm.CfnPatchBaseline.PatchFilterProperty(
            key="key",
            values=["values"]
        )]
    ),
    operating_system="operatingSystem",
    patch_groups=["patchGroups"],
    rejected_patches=["rejectedPatches"],
    rejected_patches_action="rejectedPatchesAction",
    sources=[ssm.CfnPatchBaseline.PatchSourceProperty(
        configuration="configuration",
        name="name",
        products=["products"]
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

approval_rules

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

Link

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

Return type

Union[IResolvable, RuleGroupProperty, None]

approved_patches

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 .

Link

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

Return type

Optional[List[str]]

approved_patches_compliance_level

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 .

Link

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

Return type

Optional[str]

approved_patches_enable_non_security

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.

Link

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

Return type

Union[bool, IResolvable, None]

description

A description of the patch baseline.

Link

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

Return type

Optional[str]

global_filters

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

Link

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

Return type

Union[IResolvable, PatchFilterGroupProperty, None]

name

The name of the patch baseline.

Link

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

Return type

str

operating_system

Defines the operating system the patch baseline applies to.

The default value is WINDOWS .

Link

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

Return type

Optional[str]

patch_groups

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

Link

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

Return type

Optional[List[str]]

rejected_patches

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 .

Link

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

Return type

Optional[List[str]]

rejected_patches_action

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 .

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, PatchSourceProperty]], None]

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.

Link

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

Return type

Optional[List[CfnTag]]