Class Evaluation

java.lang.Object
com.amazonaws.services.config.model.Evaluation
All Implemented Interfaces:
Serializable, Cloneable

public class Evaluation extends Object implements Serializable, Cloneable

Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.

See Also:
  • Constructor Details

    • Evaluation

      public Evaluation()
  • Method Details

    • setComplianceResourceType

      public void setComplianceResourceType(String complianceResourceType)

      The type of AWS resource that was evaluated.

      Parameters:
      complianceResourceType - The type of AWS resource that was evaluated.
    • getComplianceResourceType

      public String getComplianceResourceType()

      The type of AWS resource that was evaluated.

      Returns:
      The type of AWS resource that was evaluated.
    • withComplianceResourceType

      public Evaluation withComplianceResourceType(String complianceResourceType)

      The type of AWS resource that was evaluated.

      Parameters:
      complianceResourceType - The type of AWS resource that was evaluated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setComplianceResourceId

      public void setComplianceResourceId(String complianceResourceId)

      The ID of the AWS resource that was evaluated.

      Parameters:
      complianceResourceId - The ID of the AWS resource that was evaluated.
    • getComplianceResourceId

      public String getComplianceResourceId()

      The ID of the AWS resource that was evaluated.

      Returns:
      The ID of the AWS resource that was evaluated.
    • withComplianceResourceId

      public Evaluation withComplianceResourceId(String complianceResourceId)

      The ID of the AWS resource that was evaluated.

      Parameters:
      complianceResourceId - The ID of the AWS resource that was evaluated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setComplianceType

      public void setComplianceType(String complianceType)

      Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

      For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

      Parameters:
      complianceType - Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

      For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

      See Also:
    • getComplianceType

      public String getComplianceType()

      Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

      For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

      Returns:
      Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

      For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

      See Also:
    • withComplianceType

      public Evaluation withComplianceType(String complianceType)

      Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

      For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

      Parameters:
      complianceType - Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

      For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setComplianceType

      public void setComplianceType(ComplianceType complianceType)

      Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

      For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

      Parameters:
      complianceType - Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

      For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

      See Also:
    • withComplianceType

      public Evaluation withComplianceType(ComplianceType complianceType)

      Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

      For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

      Parameters:
      complianceType - Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

      For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

      Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setAnnotation

      public void setAnnotation(String annotation)

      Supplementary information about how the evaluation determined the compliance.

      Parameters:
      annotation - Supplementary information about how the evaluation determined the compliance.
    • getAnnotation

      public String getAnnotation()

      Supplementary information about how the evaluation determined the compliance.

      Returns:
      Supplementary information about how the evaluation determined the compliance.
    • withAnnotation

      public Evaluation withAnnotation(String annotation)

      Supplementary information about how the evaluation determined the compliance.

      Parameters:
      annotation - Supplementary information about how the evaluation determined the compliance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setOrderingTimestamp

      public void setOrderingTimestamp(Date orderingTimestamp)

      The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config delivered the configuration snapshot that triggered the evaluation.

      Parameters:
      orderingTimestamp - The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config delivered the configuration snapshot that triggered the evaluation.
    • getOrderingTimestamp

      public Date getOrderingTimestamp()

      The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config delivered the configuration snapshot that triggered the evaluation.

      Returns:
      The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config delivered the configuration snapshot that triggered the evaluation.
    • withOrderingTimestamp

      public Evaluation withOrderingTimestamp(Date orderingTimestamp)

      The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config delivered the configuration snapshot that triggered the evaluation.

      Parameters:
      orderingTimestamp - The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config delivered the configuration snapshot that triggered the evaluation.
      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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public Evaluation clone()
      Overrides:
      clone in class Object