You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ConfigService::Types::Evaluation
- Inherits:
-
Struct
- Object
- Struct
- Aws::ConfigService::Types::Evaluation
- Defined in:
- (unknown)
Overview
When passing Evaluation as input to an Aws::Client method, you can use a vanilla Hash:
{
compliance_resource_type: "StringWithCharLimit256", # required
compliance_resource_id: "BaseResourceId", # required
compliance_type: "COMPLIANT", # required, accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
annotation: "StringWithCharLimit256",
ordering_timestamp: Time.now, # required
}
Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.
Instance Attribute Summary collapse
-
#annotation ⇒ String
Supplementary information about how the evaluation determined the compliance.
-
#compliance_resource_id ⇒ String
The ID of the AWS resource that was evaluated.
-
#compliance_resource_type ⇒ String
The type of AWS resource that was evaluated.
-
#compliance_type ⇒ String
Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.
-
#ordering_timestamp ⇒ Time
The time of the event in AWS Config that triggered the evaluation.
Instance Attribute Details
#annotation ⇒ String
Supplementary information about how the evaluation determined the compliance.
#compliance_resource_id ⇒ String
The ID of the AWS resource that was evaluated.
#compliance_resource_type ⇒ String
The type of AWS resource that was evaluated.
#compliance_type ⇒ String
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 AWS Config rule cannot pass an
INSUFFICIENT_DATA
value to AWS Config.
Possible values:
- COMPLIANT
- NON_COMPLIANT
- NOT_APPLICABLE
- INSUFFICIENT_DATA
#ordering_timestamp ⇒ Time
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 triggered the evaluation at the frequency that you specified (for example, every 24 hours).