com.amazonaws.services.securityhub.model

Class Compliance

java.lang.Object

com.amazonaws.services.securityhub.model.Compliance

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Compliance
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Compliance()

Method Summary

Modifier and Type	Method and Description
Compliance	clone()
boolean	equals(Object obj)
List<AssociatedStandard>	getAssociatedStandards() The enabled security standards in which a security control is currently enabled.
List<String>	getRelatedRequirements() For a control, the industry or regulatory framework requirements that are related to the control.
String	getSecurityControlId() The unique identifier of a control across standards.
List<SecurityControlParameter>	getSecurityControlParameters() An object that includes security control parameter names and values.
String	getStatus() The result of a standards check.
List<StatusReason>	getStatusReasons() For findings generated from controls, a list of reasons behind the value of Status.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAssociatedStandards(Collection<AssociatedStandard> associatedStandards) The enabled security standards in which a security control is currently enabled.
void	setRelatedRequirements(Collection<String> relatedRequirements) For a control, the industry or regulatory framework requirements that are related to the control.
void	setSecurityControlId(String securityControlId) The unique identifier of a control across standards.
void	setSecurityControlParameters(Collection<SecurityControlParameter> securityControlParameters) An object that includes security control parameter names and values.
void	setStatus(String status) The result of a standards check.
void	setStatusReasons(Collection<StatusReason> statusReasons) For findings generated from controls, a list of reasons behind the value of Status.
String	toString() Returns a string representation of this object.
Compliance	withAssociatedStandards(AssociatedStandard... associatedStandards) The enabled security standards in which a security control is currently enabled.
Compliance	withAssociatedStandards(Collection<AssociatedStandard> associatedStandards) The enabled security standards in which a security control is currently enabled.
Compliance	withRelatedRequirements(Collection<String> relatedRequirements) For a control, the industry or regulatory framework requirements that are related to the control.
Compliance	withRelatedRequirements(String... relatedRequirements) For a control, the industry or regulatory framework requirements that are related to the control.
Compliance	withSecurityControlId(String securityControlId) The unique identifier of a control across standards.
Compliance	withSecurityControlParameters(Collection<SecurityControlParameter> securityControlParameters) An object that includes security control parameter names and values.
Compliance	withSecurityControlParameters(SecurityControlParameter... securityControlParameters) An object that includes security control parameter names and values.
Compliance	withStatus(ComplianceStatus status) The result of a standards check.
Compliance	withStatus(String status) The result of a standards check.
Compliance	withStatusReasons(Collection<StatusReason> statusReasons) For findings generated from controls, a list of reasons behind the value of Status.
Compliance	withStatusReasons(StatusReason... statusReasons) For findings generated from controls, a list of reasons behind the value of Status.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Compliance

public Compliance()

Method Detail

setStatus

public void setStatus(String 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 for a Security Hub control, Security Hub automatically archives the finding after 3 days.

Parameters:

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

See Also:

ComplianceStatus

getStatus

public String getStatus()

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

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

See Also:

ComplianceStatus

withStatus

public Compliance withStatus(String 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 for a Security Hub control, Security Hub automatically archives the finding after 3 days.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComplianceStatus

withStatus

public Compliance withStatus(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 for a Security Hub control, Security Hub automatically archives the finding after 3 days.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComplianceStatus

getRelatedRequirements

public List<String> getRelatedRequirements()

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.

Array Members: Maximum number of 32 items.

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.

Array Members: Maximum number of 32 items.

setRelatedRequirements

public void setRelatedRequirements(Collection<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.

Array Members: Maximum number of 32 items.

Parameters:

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.

Array Members: Maximum number of 32 items.

withRelatedRequirements

public Compliance withRelatedRequirements(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.

Array Members: Maximum number of 32 items.

NOTE: This method appends the values to the existing list (if any). Use setRelatedRequirements(java.util.Collection) or withRelatedRequirements(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Array Members: Maximum number of 32 items.

Returns:

Returns a reference to this object so that method calls can be chained together.

withRelatedRequirements

public Compliance withRelatedRequirements(Collection<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.

Array Members: Maximum number of 32 items.

Parameters:

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.

Array Members: Maximum number of 32 items.

Returns:

Returns a reference to this object so that method calls can be chained together.

getStatusReasons

public List<StatusReason> getStatusReasons()

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.

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.

setStatusReasons

public void setStatusReasons(Collection<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.

Parameters:

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.

withStatusReasons

public Compliance withStatusReasons(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.

NOTE: This method appends the values to the existing list (if any). Use setStatusReasons(java.util.Collection) or withStatusReasons(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withStatusReasons

public Compliance withStatusReasons(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSecurityControlId

public void setSecurityControlId(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.

Parameters:

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.

getSecurityControlId

public String getSecurityControlId()

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.

withSecurityControlId

public Compliance withSecurityControlId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getAssociatedStandards

public List<AssociatedStandard> getAssociatedStandards()

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

Returns:

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

setAssociatedStandards

public void setAssociatedStandards(Collection<AssociatedStandard> associatedStandards)

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

Parameters:

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

withAssociatedStandards

public Compliance withAssociatedStandards(AssociatedStandard... associatedStandards)

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

NOTE: This method appends the values to the existing list (if any). Use setAssociatedStandards(java.util.Collection) or withAssociatedStandards(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withAssociatedStandards

public Compliance withAssociatedStandards(Collection<AssociatedStandard> associatedStandards)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getSecurityControlParameters

public List<SecurityControlParameter> getSecurityControlParameters()

An object that includes security control parameter names and values.

Returns:

An object that includes security control parameter names and values.

setSecurityControlParameters

public void setSecurityControlParameters(Collection<SecurityControlParameter> securityControlParameters)

An object that includes security control parameter names and values.

Parameters:

securityControlParameters - An object that includes security control parameter names and values.

withSecurityControlParameters

public Compliance withSecurityControlParameters(SecurityControlParameter... securityControlParameters)

An object that includes security control parameter names and values.

NOTE: This method appends the values to the existing list (if any). Use setSecurityControlParameters(java.util.Collection) or withSecurityControlParameters(java.util.Collection) if you want to override the existing values.

Parameters:

securityControlParameters - An object that includes security control parameter names and values.

Returns:

Returns a reference to this object so that method calls can be chained together.

withSecurityControlParameters

public Compliance withSecurityControlParameters(Collection<SecurityControlParameter> securityControlParameters)

An object that includes security control parameter names and values.

Parameters:

securityControlParameters - An object that includes security control parameter names and values.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public Compliance clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.