Package software.amazon.awscdk.services.ssm

Interface CfnPatchBaselineProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnPatchBaselineProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.797Z") @Stability(Stable) public interface CfnPatchBaselineProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnPatchBaseline.

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.*;
 CfnPatchBaselineProps cfnPatchBaselineProps = CfnPatchBaselineProps.builder()
         .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)
         .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();

  • Method Details

    • getName

      @Stability(Stable) @NotNull String getName()
      The name of the patch baseline.

    • getApprovalRules

      @Stability(Stable) @Nullable default Object getApprovalRules()
      A set of rules used to include patches in the baseline.

    • getApprovedPatches

      @Stability(Stable) @Nullable default List<String> getApprovedPatches()
      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 .

    • getApprovedPatchesComplianceLevel

      @Stability(Stable) @Nullable default String getApprovedPatchesComplianceLevel()
      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 .

    • getApprovedPatchesEnableNonSecurity

      @Stability(Stable) @Nullable default Object getApprovedPatchesEnableNonSecurity()
      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.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description of the patch baseline.

    • getGlobalFilters

      @Stability(Stable) @Nullable default Object getGlobalFilters()
      A set of global filters used to include patches in the baseline.

    • getOperatingSystem

      @Stability(Stable) @Nullable default String getOperatingSystem()
      Defines the operating system the patch baseline applies to.

      The default value is WINDOWS .

    • getPatchGroups

      @Stability(Stable) @Nullable default List<String> getPatchGroups()
      The name of the patch group to be registered with the patch baseline.

    • getRejectedPatches

      @Stability(Stable) @Nullable default List<String> getRejectedPatches()
      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 .

    • getRejectedPatchesAction

      @Stability(Stable) @Nullable default String getRejectedPatchesAction()
      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 .

    • getSources

      @Stability(Stable) @Nullable default Object getSources()
      Information about the patches to use to update the managed nodes, including target operating systems and source repositories.

      Applies to Linux managed nodes only.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      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.

    • builder

      @Stability(Stable) static CfnPatchBaselineProps.Builder builder()
      Returns:
      a CfnPatchBaselineProps.Builder of CfnPatchBaselineProps