Package software.amazon.awssdk.services.ssm.model

Interface CreatePatchBaselineRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreatePatchBaselineRequest.Builder,CreatePatchBaselineRequest>, SdkBuilder<CreatePatchBaselineRequest.Builder,CreatePatchBaselineRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder
Enclosing class:
CreatePatchBaselineRequest
public static interface CreatePatchBaselineRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<CreatePatchBaselineRequest.Builder,CreatePatchBaselineRequest>

  • Method Details

    • operatingSystem

      CreatePatchBaselineRequest.Builder operatingSystem(String operatingSystem)

      Defines the operating system the patch baseline applies to. The default value is WINDOWS.

      Parameters:
      operatingSystem - Defines the operating system the patch baseline applies to. The default value is WINDOWS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • operatingSystem

      CreatePatchBaselineRequest.Builder operatingSystem(OperatingSystem operatingSystem)

      Defines the operating system the patch baseline applies to. The default value is WINDOWS.

      Parameters:
      operatingSystem - Defines the operating system the patch baseline applies to. The default value is WINDOWS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      CreatePatchBaselineRequest.Builder name(String name)

      The name of the patch baseline.

      Parameters:
      name - The name of the patch baseline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • globalFilters

      CreatePatchBaselineRequest.Builder globalFilters(PatchFilterGroup 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • globalFilters

      default CreatePatchBaselineRequest.Builder globalFilters(Consumer<PatchFilterGroup.Builder> globalFilters)

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

      This is a convenience method that creates an instance of the PatchFilterGroup.Builder avoiding the need to create one manually via PatchFilterGroup.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to globalFilters(PatchFilterGroup).

      Parameters:
      globalFilters - a consumer that will call methods on PatchFilterGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • approvalRules

      CreatePatchBaselineRequest.Builder approvalRules(PatchRuleGroup 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • approvalRules

      default CreatePatchBaselineRequest.Builder approvalRules(Consumer<PatchRuleGroup.Builder> approvalRules)

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

      This is a convenience method that creates an instance of the PatchRuleGroup.Builder avoiding the need to create one manually via PatchRuleGroup.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to approvalRules(PatchRuleGroup).

      Parameters:
      approvalRules - a consumer that will call methods on PatchRuleGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • approvedPatches

      CreatePatchBaselineRequest.Builder approvedPatches(Collection<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 Amazon Web Services Systems Manager User Guide.

      Parameters:
      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 Amazon Web Services Systems Manager User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • approvedPatches

      CreatePatchBaselineRequest.Builder approvedPatches(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 Amazon Web Services Systems Manager User Guide.

      Parameters:
      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 Amazon Web Services Systems Manager User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • approvedPatchesComplianceLevel

      CreatePatchBaselineRequest.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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • approvedPatchesComplianceLevel

      CreatePatchBaselineRequest.Builder approvedPatchesComplianceLevel(PatchComplianceLevel 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • approvedPatchesEnableNonSecurity

      CreatePatchBaselineRequest.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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rejectedPatches

      CreatePatchBaselineRequest.Builder rejectedPatches(Collection<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 Amazon Web Services Systems Manager User Guide.

      Parameters:
      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 Amazon Web Services Systems Manager User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rejectedPatches

      CreatePatchBaselineRequest.Builder rejectedPatches(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 Amazon Web Services Systems Manager User Guide.

      Parameters:
      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 Amazon Web Services Systems Manager User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rejectedPatchesAction

      CreatePatchBaselineRequest.Builder rejectedPatchesAction(String rejectedPatchesAction)

      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 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.

      Parameters:
      rejectedPatchesAction - 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 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • rejectedPatchesAction

      CreatePatchBaselineRequest.Builder rejectedPatchesAction(PatchAction rejectedPatchesAction)

      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 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.

      Parameters:
      rejectedPatchesAction - 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 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      CreatePatchBaselineRequest.Builder description(String description)

      A description of the patch baseline.

      Parameters:
      description - A description of the patch baseline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sources

      CreatePatchBaselineRequest.Builder sources(Collection<PatchSource> 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. Applies to Linux managed nodes only.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sources

      CreatePatchBaselineRequest.Builder sources(PatchSource... 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. Applies to Linux managed nodes only.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sources

      CreatePatchBaselineRequest.Builder sources(Consumer<PatchSource.Builder>... 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.

      This is a convenience method that creates an instance of the PatchSource.Builder avoiding the need to create one manually via PatchSource.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sources(List<PatchSource>).

      Parameters:
      sources - a consumer that will call methods on PatchSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreatePatchBaselineRequest.Builder clientToken(String clientToken)

      User-provided idempotency token.

      Parameters:
      clientToken - User-provided idempotency token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePatchBaselineRequest.Builder tags(Collection<Tag> 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. In this case, you could specify the following key-value pairs:

      • Key=PatchSeverity,Value=Critical

      • Key=OS,Value=Windows

      To add tags to an existing patch baseline, use the AddTagsToResource operation.

      Parameters:
      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. In this case, you could specify the following key-value pairs:

      • Key=PatchSeverity,Value=Critical

      • Key=OS,Value=Windows

      To add tags to an existing patch baseline, use the AddTagsToResource operation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePatchBaselineRequest.Builder tags(Tag... 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. In this case, you could specify the following key-value pairs:

      • Key=PatchSeverity,Value=Critical

      • Key=OS,Value=Windows

      To add tags to an existing patch baseline, use the AddTagsToResource operation.

      Parameters:
      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. In this case, you could specify the following key-value pairs:

      • Key=PatchSeverity,Value=Critical

      • Key=OS,Value=Windows

      To add tags to an existing patch baseline, use the AddTagsToResource operation.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePatchBaselineRequest.Builder tags(Consumer<Tag.Builder>... 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. In this case, you could specify the following key-value pairs:

      • Key=PatchSeverity,Value=Critical

      • Key=OS,Value=Windows

      To add tags to an existing patch baseline, use the AddTagsToResource operation.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreatePatchBaselineRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreatePatchBaselineRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.