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

Class Compliance

    • Method Detail

      • status

        public final ComplianceStatus status()

        Typically summarizes the result of a control check.

        For Security Hub controls, 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 for a Security Hub control, Security Hub automatically archives the finding after 3 days.

        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:
        Typically summarizes the result of a control check.

        For Security Hub controls, 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 for a Security Hub control, Security Hub automatically archives the finding after 3 days.

        See Also:
        ComplianceStatus

      • statusAsString

        public final String statusAsString()

        Typically summarizes the result of a control check.

        For Security Hub controls, 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 for a Security Hub control, Security Hub automatically archives the finding after 3 days.

        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:
        Typically summarizes the result of a control check.

        For Security Hub controls, 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 for a Security Hub control, Security Hub automatically archives the finding after 3 days.

        See Also:
        ComplianceStatus

      • 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()

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

        Array Members: Maximum number of 32 items.

        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:
        Typically provides the industry or regulatory framework requirements that are related to a control. The check for that control is aligned with these requirements.

        Array Members: Maximum number of 32 items.

      • 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()

        Typically used to provide a list of reasons for the value of Status.

        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:
        Typically used to provide a list of reasons for the value of Status.

      • securityControlId

        public final String securityControlId()

        Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an Amazon Web Services service and a unique number, such as APIGateway.5.

        Returns:
        Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an Amazon Web Services service and a unique 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()

        Typically provides an array of 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:
        Typically provides an array of enabled security standards in which a security control is currently enabled.

      • hasSecurityControlParameters

        public final boolean hasSecurityControlParameters()
        For responses, this returns true if the service returned a value for the SecurityControlParameters 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.

      • securityControlParameters

        public final List<SecurityControlParameter> securityControlParameters()

        Typically an object that includes security control parameter names and values.

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

        Returns:
        Typically an object that includes security control parameter names and values.

      • hashCode

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

      • equals

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

      • 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)