Class Severity

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

The severity of the finding.

The finding provider can provide the initial severity. The finding provider can only update the severity if it hasn't been updated using BatchUpdateFindings.

The finding must have either Label or Normalized populated. If only one of these attributes is populated, then Security Hub automatically populates the other one. If neither attribute is populated, then the finding is invalid. Label is the preferred attribute.

See Also:

  • Method Details

    • product

      public final Double product()

      Deprecated. This attribute isn't included in findings. Instead of providing Product, provide Original.

      The native severity as defined by the Amazon Web Services service or integrated partner product that generated the finding.

      Returns:
      Deprecated. This attribute isn't included in findings. Instead of providing Product, provide Original.

      The native severity as defined by the Amazon Web Services service or integrated partner product that generated the finding.

    • label

      public final SeverityLabel label()

      The severity value of the finding. The allowed values are the following.

      • INFORMATIONAL - No issue was found.

      • LOW - The issue does not require action on its own.

      • MEDIUM - The issue must be addressed but not urgently.

      • HIGH - The issue must be addressed as a priority.

      • CRITICAL - The issue must be remediated immediately to avoid it escalating.

      If you provide Normalized and don't provide Label, then Label is set automatically as follows.

      • 0 - INFORMATIONAL

      • 1–39 - LOW

      • 40–69 - MEDIUM

      • 70–89 - HIGH

      • 90–100 - CRITICAL

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

      Returns:
      The severity value of the finding. The allowed values are the following.

      • INFORMATIONAL - No issue was found.

      • LOW - The issue does not require action on its own.

      • MEDIUM - The issue must be addressed but not urgently.

      • HIGH - The issue must be addressed as a priority.

      • CRITICAL - The issue must be remediated immediately to avoid it escalating.

      If you provide Normalized and don't provide Label, then Label is set automatically as follows.

      • 0 - INFORMATIONAL

      • 1–39 - LOW

      • 40–69 - MEDIUM

      • 70–89 - HIGH

      • 90–100 - CRITICAL

      See Also:

    • labelAsString

      public final String labelAsString()

      The severity value of the finding. The allowed values are the following.

      • INFORMATIONAL - No issue was found.

      • LOW - The issue does not require action on its own.

      • MEDIUM - The issue must be addressed but not urgently.

      • HIGH - The issue must be addressed as a priority.

      • CRITICAL - The issue must be remediated immediately to avoid it escalating.

      If you provide Normalized and don't provide Label, then Label is set automatically as follows.

      • 0 - INFORMATIONAL

      • 1–39 - LOW

      • 40–69 - MEDIUM

      • 70–89 - HIGH

      • 90–100 - CRITICAL

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

      Returns:
      The severity value of the finding. The allowed values are the following.

      • INFORMATIONAL - No issue was found.

      • LOW - The issue does not require action on its own.

      • MEDIUM - The issue must be addressed but not urgently.

      • HIGH - The issue must be addressed as a priority.

      • CRITICAL - The issue must be remediated immediately to avoid it escalating.

      If you provide Normalized and don't provide Label, then Label is set automatically as follows.

      • 0 - INFORMATIONAL

      • 1–39 - LOW

      • 40–69 - MEDIUM

      • 70–89 - HIGH

      • 90–100 - CRITICAL

      See Also:

    • normalized

      public final Integer normalized()

      Deprecated. The normalized severity of a finding. Instead of providing Normalized, provide Label.

      The value of Normalized can be an integer between 0 and 100.

      If you provide Label and don't provide Normalized, then Normalized is set automatically as follows.

      • INFORMATIONAL - 0

      • LOW - 1

      • MEDIUM - 40

      • HIGH - 70

      • CRITICAL - 90

      Returns:
      Deprecated. The normalized severity of a finding. Instead of providing Normalized, provide Label.

      The value of Normalized can be an integer between 0 and 100.

      If you provide Label and don't provide Normalized, then Normalized is set automatically as follows.

      • INFORMATIONAL - 0

      • LOW - 1

      • MEDIUM - 40

      • HIGH - 70

      • CRITICAL - 90

    • original

      public final String original()

      The native severity from the finding product that generated the finding.

      Length Constraints: Minimum length of 1. Maximum length of 64.

      Returns:
      The native severity from the finding product that generated the finding.

      Length Constraints: Minimum length of 1. Maximum length of 64.

    • toBuilder

      public Severity.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Severity.Builder,Severity>
      Returns:
      a builder for type T

    • builder

      public static Severity.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Severity.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.