Class Compliance
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Compliance.Builder,
Compliance>
Contains finding details that are specific to control-based findings. Only returned for findings generated from controls.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<AssociatedStandard> The enabled security standards in which a security control is currently enabled.static Compliance.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AssociatedStandards property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RelatedRequirements property.final boolean
For responses, this returns true if the service returned a value for the SecurityControlParameters property.final boolean
For responses, this returns true if the service returned a value for the StatusReasons property.For a control, the industry or regulatory framework requirements that are related to the control.final String
The unique identifier of a control across standards.final List
<SecurityControlParameter> An object that includes security control parameter names and values.static Class
<? extends Compliance.Builder> final ComplianceStatus
status()
The result of a standards check.final String
The result of a standards check.final List
<StatusReason> For findings generated from controls, a list of reasons behind the value ofStatus
.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 wasNOT_APPLICABLE
. If the Config evaluation result wasNOT_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 returnComplianceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 wasNOT_APPLICABLE
. If the Config evaluation result wasNOT_APPLICABLE
, then after 3 days, Security Hub automatically archives the finding.
-
-
- See Also:
-
-
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 wasNOT_APPLICABLE
. If the Config evaluation result wasNOT_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 returnComplianceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 wasNOT_APPLICABLE
. If the Config evaluation result wasNOT_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 theisEmpty()
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. -
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 theisEmpty()
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
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
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 theisEmpty()
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
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.
-
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 theisEmpty()
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
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:
- An object that includes security control parameter names and values.
-
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 interfaceToCopyableBuilder<Compliance.Builder,
Compliance> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-