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 Summary

Modifier and Type	Method and Description
default CreatePatchBaselineRequest.Builder	approvalRules(Consumer<PatchRuleGroup.Builder> approvalRules) A set of rules used to include patches in the baseline.
CreatePatchBaselineRequest.Builder	approvalRules(PatchRuleGroup approvalRules) A set of rules used to include patches in the baseline.
CreatePatchBaselineRequest.Builder	approvedPatches(Collection<String> approvedPatches) A list of explicitly approved patches for the baseline.
CreatePatchBaselineRequest.Builder	approvedPatches(String... approvedPatches) A list of explicitly approved patches for the baseline.
CreatePatchBaselineRequest.Builder	approvedPatchesComplianceLevel(PatchComplianceLevel approvedPatchesComplianceLevel) Defines the compliance level for approved patches.
CreatePatchBaselineRequest.Builder	approvedPatchesComplianceLevel(String approvedPatchesComplianceLevel) Defines the compliance level for approved patches.
CreatePatchBaselineRequest.Builder	approvedPatchesEnableNonSecurity(Boolean approvedPatchesEnableNonSecurity) Indicates whether the list of approved patches includes non-security updates that should be applied to the instances.
CreatePatchBaselineRequest.Builder	clientToken(String clientToken) User-provided idempotency token.
CreatePatchBaselineRequest.Builder	description(String description) A description of the patch baseline.
default CreatePatchBaselineRequest.Builder	globalFilters(Consumer<PatchFilterGroup.Builder> globalFilters) A set of global filters used to exclude patches from the baseline.
CreatePatchBaselineRequest.Builder	globalFilters(PatchFilterGroup globalFilters) A set of global filters used to exclude patches from the baseline.
CreatePatchBaselineRequest.Builder	name(String name) The name of the patch baseline.
CreatePatchBaselineRequest.Builder	operatingSystem(OperatingSystem operatingSystem) Defines the operating system the patch baseline applies to.
CreatePatchBaselineRequest.Builder	operatingSystem(String operatingSystem) Defines the operating system the patch baseline applies to.
CreatePatchBaselineRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreatePatchBaselineRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreatePatchBaselineRequest.Builder	rejectedPatches(Collection<String> rejectedPatches) A list of explicitly rejected patches for the baseline.
CreatePatchBaselineRequest.Builder	rejectedPatches(String... rejectedPatches) A list of explicitly rejected patches for the baseline.
CreatePatchBaselineRequest.Builder	rejectedPatchesAction(PatchAction rejectedPatchesAction) The action for Patch Manager to take on patches included in the RejectedPackages list.
CreatePatchBaselineRequest.Builder	rejectedPatchesAction(String rejectedPatchesAction) The action for Patch Manager to take on patches included in the RejectedPackages list.
CreatePatchBaselineRequest.Builder	sources(Collection<PatchSource> sources) Information about the patches to use to update the instances, including target operating systems and source repositories.
CreatePatchBaselineRequest.Builder	sources(Consumer<PatchSource.Builder>... sources) Information about the patches to use to update the instances, including target operating systems and source repositories.
CreatePatchBaselineRequest.Builder	sources(PatchSource... sources) Information about the patches to use to update the instances, including target operating systems and source repositories.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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, OperatingSystem

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:

OperatingSystem, OperatingSystem

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 exclude patches from the baseline.

Parameters:

globalFilters - A set of global filters used to exclude patches from 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 exclude patches from the baseline.

This is a convenience 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:

globalFilters(PatchFilterGroup)

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

approvalRules(PatchRuleGroup)

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

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

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 AWS 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. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.

Parameters:

approvedPatchesComplianceLevel - Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is 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:

PatchComplianceLevel, PatchComplianceLevel

approvedPatchesComplianceLevel

CreatePatchBaselineRequest.Builder approvedPatchesComplianceLevel(PatchComplianceLevel approvedPatchesComplianceLevel)

Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.

Parameters:

approvedPatchesComplianceLevel - Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is 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:

PatchComplianceLevel, PatchComplianceLevel

approvedPatchesEnableNonSecurity

CreatePatchBaselineRequest.Builder approvedPatchesEnableNonSecurity(Boolean approvedPatchesEnableNonSecurity)

Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

Parameters:

approvedPatchesEnableNonSecurity - Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances 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 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.

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

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 AWS 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 RejectedPatches list, and packages that include them as dependencies, are not 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.

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 RejectedPatches list, and packages that include them as dependencies, are not 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.

Returns:

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

See Also:

PatchAction, PatchAction

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 RejectedPatches list, and packages that include them as dependencies, are not 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.

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 RejectedPatches list, and packages that include them as dependencies, are not 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.

Returns:

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

See Also:

PatchAction, PatchAction

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 instances, including target operating systems and source repositories. Applies to Linux instances only.

Parameters:

sources - Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances 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 instances, including target operating systems and source repositories. Applies to Linux instances only.

Parameters:

sources - Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances 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 instances, including target operating systems and source repositories. Applies to Linux instances only.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #sources(List).

Parameters:

sources - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#sources(List)

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.

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.