Interface UpdatePatchBaselineRequest.Builder

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

  • Method Details

    • baselineId

      UpdatePatchBaselineRequest.Builder baselineId(String baselineId)

      The ID of the patch baseline to update.

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

    • name

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

      UpdatePatchBaselineRequest.Builder globalFilters(PatchFilterGroup globalFilters)

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

      The GlobalFilters parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.

      Parameters:
      globalFilters - A set of global filters used to include patches in the baseline.

      The GlobalFilters parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.

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

    • globalFilters

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

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

      The GlobalFilters parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.

      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

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

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

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

      UpdatePatchBaselineRequest.Builder approvedPatchesComplianceLevel(String approvedPatchesComplianceLevel)

      Assigns a new compliance severity level to an existing patch baseline.

      Parameters:
      approvedPatchesComplianceLevel - Assigns a new compliance severity level to an existing patch baseline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • approvedPatchesComplianceLevel

      UpdatePatchBaselineRequest.Builder approvedPatchesComplianceLevel(PatchComplianceLevel approvedPatchesComplianceLevel)

      Assigns a new compliance severity level to an existing patch baseline.

      Parameters:
      approvedPatchesComplianceLevel - Assigns a new compliance severity level to an existing patch baseline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • approvedPatchesEnableNonSecurity

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

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

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

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

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

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

    • rejectedPatchesAction

      UpdatePatchBaselineRequest.Builder rejectedPatchesAction(PatchAction 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.

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

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

    • description

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

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

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

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

    • availableSecurityUpdatesComplianceStatus

      UpdatePatchBaselineRequest.Builder availableSecurityUpdatesComplianceStatus(String availableSecurityUpdatesComplianceStatus)

      Indicates the status to be assigned to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.

      Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.

      Supported for Windows Server managed nodes only.

      Parameters:
      availableSecurityUpdatesComplianceStatus - Indicates the status to be assigned to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.

      Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.

      Supported for Windows Server managed nodes only.

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

    • availableSecurityUpdatesComplianceStatus

      UpdatePatchBaselineRequest.Builder availableSecurityUpdatesComplianceStatus(PatchComplianceStatus availableSecurityUpdatesComplianceStatus)

      Indicates the status to be assigned to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.

      Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.

      Supported for Windows Server managed nodes only.

      Parameters:
      availableSecurityUpdatesComplianceStatus - Indicates the status to be assigned to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.

      Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.

      Supported for Windows Server managed nodes only.

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

    • replace

      UpdatePatchBaselineRequest.Builder replace(Boolean replace)

      If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request. Optional fields that aren't specified are set to null.

      Parameters:
      replace - If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request. Optional fields that aren't specified are set to null.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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