Package software.amazon.awssdk.services.securityhub.model

Class Compliance

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

Contains finding details that are specific to control-based findings. Only returned for findings generated from controls.

See Also:

  • Method Details

    • status

      public final ComplianceStatus status()

      The result of a standards check.

      The valid values for Status are as follows.

        • PASSED - Standards check passed for all evaluated resources.

        • WARNING - Some information is missing or this check is not supported for your configuration.

        • FAILED - Standards check failed for at least one evaluated resource.

        • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.

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

      Returns:
      The result of a standards check.

      The valid values for Status are as follows.

        • PASSED - Standards check passed for all evaluated resources.

        • WARNING - Some information is missing or this check is not supported for your configuration.

        • FAILED - Standards check failed for at least one evaluated resource.

        • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.

      See Also:

    • statusAsString

      public final String statusAsString()

      The result of a standards check.

      The valid values for Status are as follows.

        • PASSED - Standards check passed for all evaluated resources.

        • WARNING - Some information is missing or this check is not supported for your configuration.

        • FAILED - Standards check failed for at least one evaluated resource.

        • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.

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

      Returns:
      The result of a standards check.

      The valid values for Status are as follows.

        • PASSED - Standards check passed for all evaluated resources.

        • WARNING - Some information is missing or this check is not supported for your configuration.

        • FAILED - Standards check failed for at least one evaluated resource.

        • NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.

      See Also:

    • hasRelatedRequirements

      public final boolean hasRelatedRequirements()
      For responses, this returns true if the service returned a value for the RelatedRequirements property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • relatedRequirements

      public final List<String> relatedRequirements()

      For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.

      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 hasRelatedRequirements() method.

      Returns:
      For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.

    • hasStatusReasons

      public final boolean hasStatusReasons()
      For responses, this returns true if the service returned a value for the StatusReasons property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • statusReasons

      public final List<StatusReason> statusReasons()

      For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub 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 hasStatusReasons() method.

      Returns:
      For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.

    • securityControlId

      public final String securityControlId()

      The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Service and a number, such as APIGateway.5.

      Returns:
      The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Service and a number, such as APIGateway.5.

    • hasAssociatedStandards

      public final boolean hasAssociatedStandards()
      For responses, this returns true if the service returned a value for the AssociatedStandards property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • associatedStandards

      public final List<AssociatedStandard> associatedStandards()

      The enabled security standards in which a security control is currently enabled.

      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 hasAssociatedStandards() method.

      Returns:
      The enabled security standards in which a security control is currently enabled.

    • toBuilder

      public Compliance.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<Compliance.Builder,Compliance>
      Returns:
      a builder for type T

    • builder

      public static Compliance.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Compliance.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.