Class UpdatePatchBaselineRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ssm.model.SsmRequest
-
- software.amazon.awssdk.services.ssm.model.UpdatePatchBaselineRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdatePatchBaselineRequest.Builder,UpdatePatchBaselineRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdatePatchBaselineRequest extends SsmRequest implements ToCopyableBuilder<UpdatePatchBaselineRequest.Builder,UpdatePatchBaselineRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
UpdatePatchBaselineRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PatchRuleGroup
approvalRules()
A set of rules used to include patches in the baseline.List<String>
approvedPatches()
A list of explicitly approved patches for the baseline.PatchComplianceLevel
approvedPatchesComplianceLevel()
Assigns a new compliance severity level to an existing patch baseline.String
approvedPatchesComplianceLevelAsString()
Assigns a new compliance severity level to an existing patch baseline.Boolean
approvedPatchesEnableNonSecurity()
Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes.String
baselineId()
The ID of the patch baseline to update.static UpdatePatchBaselineRequest.Builder
builder()
String
description()
A description of the patch baseline.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
PatchFilterGroup
globalFilters()
A set of global filters used to include patches in the baseline.boolean
hasApprovedPatches()
For responses, this returns true if the service returned a value for the ApprovedPatches property.int
hashCode()
boolean
hasRejectedPatches()
For responses, this returns true if the service returned a value for the RejectedPatches property.boolean
hasSources()
For responses, this returns true if the service returned a value for the Sources property.String
name()
The name of the patch baseline.List<String>
rejectedPatches()
A list of explicitly rejected patches for the baseline.PatchAction
rejectedPatchesAction()
The action for Patch Manager to take on patches included in theRejectedPackages
list.String
rejectedPatchesActionAsString()
The action for Patch Manager to take on patches included in theRejectedPackages
list.Boolean
replace()
If True, then all fields that are required by the CreatePatchBaseline operation are also required for this API request.List<SdkField<?>>
sdkFields()
static Class<? extends UpdatePatchBaselineRequest.Builder>
serializableBuilderClass()
List<PatchSource>
sources()
Information about the patches to use to update the managed nodes, including target operating systems and source repositories.UpdatePatchBaselineRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
baselineId
public final String baselineId()
The ID of the patch baseline to update.
- Returns:
- The ID of the patch baseline to update.
-
name
public final String name()
The name of the patch baseline.
- Returns:
- The name of the patch baseline.
-
globalFilters
public final PatchFilterGroup globalFilters()
A set of global filters used to include patches in the baseline.
- Returns:
- A set of global filters used to include patches in the baseline.
-
approvalRules
public final PatchRuleGroup approvalRules()
A set of rules used to include patches in the baseline.
- Returns:
- A set of rules used to include patches in the baseline.
-
hasApprovedPatches
public final boolean hasApprovedPatches()
For responses, this returns true if the service returned a value for the ApprovedPatches property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
approvedPatches
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasApprovedPatches()
method.- Returns:
- 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.
-
approvedPatchesComplianceLevel
public final PatchComplianceLevel approvedPatchesComplianceLevel()
Assigns a new compliance severity level to an existing patch baseline.
If the service returns an enum value that is not available in the current SDK version,
approvedPatchesComplianceLevel
will returnPatchComplianceLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapprovedPatchesComplianceLevelAsString()
.- Returns:
- Assigns a new compliance severity level to an existing patch baseline.
- See Also:
PatchComplianceLevel
-
approvedPatchesComplianceLevelAsString
public final String approvedPatchesComplianceLevelAsString()
Assigns a new compliance severity level to an existing patch baseline.
If the service returns an enum value that is not available in the current SDK version,
approvedPatchesComplianceLevel
will returnPatchComplianceLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapprovedPatchesComplianceLevelAsString()
.- Returns:
- Assigns a new compliance severity level to an existing patch baseline.
- See Also:
PatchComplianceLevel
-
approvedPatchesEnableNonSecurity
public final 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.- Returns:
- 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.
-
hasRejectedPatches
public final boolean hasRejectedPatches()
For responses, this returns true if the service returned a value for the RejectedPatches property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
rejectedPatches
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRejectedPatches()
method.- Returns:
- 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.
-
rejectedPatchesAction
public final PatchAction rejectedPatchesAction()
The action for Patch Manager to take on patches included in the
RejectedPackages
list.-
ALLOW_AS_DEPENDENCY
: A package in theRejected
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 asInstalledOther
. This is the default action if no option is specified. -
BLOCK
: Packages in theRejectedPatches
list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to theRejected
patches list, it is considered non-compliant with the patch baseline, and its status is reported asInstalledRejected
.
If the service returns an enum value that is not available in the current SDK version,
rejectedPatchesAction
will returnPatchAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrejectedPatchesActionAsString()
.- Returns:
- The action for Patch Manager to take on patches included in the
RejectedPackages
list.-
ALLOW_AS_DEPENDENCY
: A package in theRejected
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 asInstalledOther
. This is the default action if no option is specified. -
BLOCK
: Packages in theRejectedPatches
list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to theRejected
patches list, it is considered non-compliant with the patch baseline, and its status is reported asInstalledRejected
.
-
- See Also:
PatchAction
-
-
rejectedPatchesActionAsString
public final String rejectedPatchesActionAsString()
The action for Patch Manager to take on patches included in the
RejectedPackages
list.-
ALLOW_AS_DEPENDENCY
: A package in theRejected
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 asInstalledOther
. This is the default action if no option is specified. -
BLOCK
: Packages in theRejectedPatches
list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to theRejected
patches list, it is considered non-compliant with the patch baseline, and its status is reported asInstalledRejected
.
If the service returns an enum value that is not available in the current SDK version,
rejectedPatchesAction
will returnPatchAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrejectedPatchesActionAsString()
.- Returns:
- The action for Patch Manager to take on patches included in the
RejectedPackages
list.-
ALLOW_AS_DEPENDENCY
: A package in theRejected
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 asInstalledOther
. This is the default action if no option is specified. -
BLOCK
: Packages in theRejectedPatches
list, and packages that include them as dependencies, aren't installed under any circumstances. If a package was installed before it was added to theRejected
patches list, it is considered non-compliant with the patch baseline, and its status is reported asInstalledRejected
.
-
- See Also:
PatchAction
-
-
description
public final String description()
A description of the patch baseline.
- Returns:
- A description of the patch baseline.
-
hasSources
public final boolean hasSources()
For responses, this returns true if the service returned a value for the Sources property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
sources
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSources()
method.- Returns:
- Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.
-
replace
public final 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.
- Returns:
- 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.
-
toBuilder
public UpdatePatchBaselineRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdatePatchBaselineRequest.Builder,UpdatePatchBaselineRequest>
- Specified by:
toBuilder
in classSsmRequest
-
builder
public static UpdatePatchBaselineRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdatePatchBaselineRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-