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(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Compliance.Builder

Method Summary

Modifier and Type	Method and Description
static Compliance.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRelatedRequirements() Returns true if the RelatedRequirements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasStatusReasons() Returns true if the StatusReasons property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	relatedRequirements() For a control, the industry or regulatory framework requirements that are related to the control.
List<SdkField<?>>	sdkFields()
static Class<? extends Compliance.Builder>	serializableBuilderClass()
ComplianceStatus	status() The result of a standards check.
String	statusAsString() The result of a standards check.
List<StatusReason>	statusReasons() For findings generated from controls, a list of reasons behind the value of Status.
Compliance.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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 AWS Config evaluation was NOT_APPLICABLE. If the AWS 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 AWS Config evaluation was NOT_APPLICABLE. If the AWS Config evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.

See Also:

ComplianceStatus

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 AWS Config evaluation was NOT_APPLICABLE. If the AWS 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 AWS Config evaluation was NOT_APPLICABLE. If the AWS Config evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.

See Also:

ComplianceStatus

hasRelatedRequirements

public final boolean hasRelatedRequirements()

Returns true if the RelatedRequirements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasRelatedRequirements() to see if a value was sent in this field.

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

Returns true if the StatusReasons property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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 AWS Security Hub User Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasStatusReasons() to see if a value was sent in this field.

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 AWS Security Hub User Guide.

toBuilder

public Compliance.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Compliance.Builder,Compliance>

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)

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