software.amazon.awssdk.services.config.model

Class Evaluation

java.lang.Object

software.amazon.awssdk.services.config.model.Evaluation

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Evaluation.Builder,Evaluation>

@Generated(value="software.amazon.awssdk:codegen")
public class Evaluation
extends Object
implements StructuredPojo, ToCopyableBuilder<Evaluation.Builder,Evaluation>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Evaluation.Builder

Method Summary

Modifier and Type	Method and Description
String	annotation() Supplementary information about how the evaluation determined the compliance.
static Evaluation.Builder	builder()
String	complianceResourceId() The ID of the AWS resource that was evaluated.
String	complianceResourceType() The type of AWS resource that was evaluated.
ComplianceType	complianceType() Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.
String	complianceTypeAsString() Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
Instant	orderingTimestamp() The time of the event in AWS Config that triggered the evaluation.
static Class<? extends Evaluation.Builder>	serializableBuilderClass()
Evaluation.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

complianceResourceType

public String complianceResourceType()

The type of AWS resource that was evaluated.

Returns:

The type of AWS resource that was evaluated.

complianceResourceId

public String complianceResourceId()

The ID of the AWS resource that was evaluated.

Returns:

The ID of the AWS resource that was evaluated.

complianceType

public 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.

If the service returns an enum value that is not available in the current SDK version, complianceType will return ComplianceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from complianceTypeAsString().

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:

ComplianceType

complianceTypeAsString

public String complianceTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, complianceType will return ComplianceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from complianceTypeAsString().

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:

ComplianceType

annotation

public String annotation()

Supplementary information about how the evaluation determined the compliance.

Returns:

Supplementary information about how the evaluation determined the compliance.

orderingTimestamp

public Instant 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 triggered the evaluation at the frequency that you specified (for example, every 24 hours).

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 triggered the evaluation at the frequency that you specified (for example, every 24 hours).

toBuilder

public Evaluation.Builder 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 interface ToCopyableBuilder<Evaluation.Builder,Evaluation>

Returns:

a builder for type T

builder

public static Evaluation.Builder builder()

serializableBuilderClass

public static Class<? extends Evaluation.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.