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

Class PatchRule

java.lang.Object
software.amazon.awssdk.services.ssm.model.PatchRule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PatchRule.Builder,PatchRule>
@Generated("software.amazon.awssdk:codegen") public final class PatchRule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PatchRule.Builder,PatchRule>

Defines an approval rule for a patch baseline.

See Also:

  • Method Details

    • patchFilterGroup

      public final PatchFilterGroup patchFilterGroup()

      The patch filter group that defines the criteria for the rule.

      Returns:
      The patch filter group that defines the criteria for the rule.

    • complianceLevel

      public final PatchComplianceLevel complianceLevel()

      A compliance severity level for all approved patches in a patch baseline.

      If the service returns an enum value that is not available in the current SDK version, complianceLevel will return PatchComplianceLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from complianceLevelAsString().

      Returns:
      A compliance severity level for all approved patches in a patch baseline.
      See Also:

    • complianceLevelAsString

      public final String complianceLevelAsString()

      A compliance severity level for all approved patches in a patch baseline.

      If the service returns an enum value that is not available in the current SDK version, complianceLevel will return PatchComplianceLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from complianceLevelAsString().

      Returns:
      A compliance severity level for all approved patches in a patch baseline.
      See Also:

    • approveAfterDays

      public final Integer approveAfterDays()

      The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released.

      Patch Manager evaluates patch release dates using Coordinated Universal Time (UTC). If a patch is released at 2025-11-09T18:00:00Z and ApproveAfterDays is set to 7, the patch will be approved after 2025-11-16T18:00:00Z.

      This parameter is marked as Required: No, but your request must include a value for either ApproveAfterDays or ApproveUntilDate.

      Not supported for Debian Server or Ubuntu Server.

      Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the Amazon Web Services Systems Manager User Guide.

      Returns:
      The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released.

      Patch Manager evaluates patch release dates using Coordinated Universal Time (UTC). If a patch is released at 2025-11-09T18:00:00Z and ApproveAfterDays is set to 7, the patch will be approved after 2025-11-16T18:00:00Z.

      This parameter is marked as Required: No, but your request must include a value for either ApproveAfterDays or ApproveUntilDate.

      Not supported for Debian Server or Ubuntu Server.

      Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the Amazon Web Services Systems Manager User Guide.

    • approveUntilDate

      public final String approveUntilDate()

      The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically.

      Enter dates in the format YYYY-MM-DD. For example, 2025-11-16.

      Patch Manager evaluates patch release dates using Coordinated Universal Time (UTC). If you enter the date 2025-11-16, patches released between 2025-11-16T00:00:00Z and 2025-11-16T23:59:59Z will be included in the approval.

      This parameter is marked as Required: No, but your request must include a value for either ApproveUntilDate or ApproveAfterDays.

      Not supported for Debian Server or Ubuntu Server.

      Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the Amazon Web Services Systems Manager User Guide.

      Returns:
      The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically.

      Enter dates in the format YYYY-MM-DD. For example, 2025-11-16.

      Patch Manager evaluates patch release dates using Coordinated Universal Time (UTC). If you enter the date 2025-11-16, patches released between 2025-11-16T00:00:00Z and 2025-11-16T23:59:59Z will be included in the approval.

      This parameter is marked as Required: No, but your request must include a value for either ApproveUntilDate or ApproveAfterDays.

      Not supported for Debian Server or Ubuntu Server.

      Use caution when setting this value for Windows Server patch baselines. Because patch updates that are replaced by later updates are removed, setting too broad a value for this parameter can result in crucial patches not being installed. For more information, see the Windows Server tab in the topic How security patches are selected in the Amazon Web Services Systems Manager User Guide.

    • enableNonSecurity

      public final Boolean enableNonSecurity()

      For managed nodes identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is false. Applies to Linux managed nodes only.

      Returns:
      For managed nodes identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is false. Applies to Linux managed nodes only.

    • toBuilder

      public PatchRule.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<PatchRule.Builder,PatchRule>

    • builder

      public static PatchRule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PatchRule.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo