Package software.amazon.awssdk.services.config.model

Class Evaluation

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Evaluation.Builder,Evaluation>

@Generated("software.amazon.awssdk:codegen")
public final class Evaluation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Evaluation.Builder,Evaluation>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Evaluation.Builder

Method Summary

Modifier and Type	Method	Description
String	annotation()	Supplementary information about how the evaluation determined the compliance.
static Evaluation.Builder	builder()
String	complianceResourceId()	The ID of the Amazon Web Services resource that was evaluated.
String	complianceResourceType()	The type of Amazon Web Services resource that was evaluated.
ComplianceType	complianceType()	Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.
String	complianceTypeAsString()	Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	orderingTimestamp()	The time of the event in Config that triggered the evaluation.
List<SdkField<?>>	sdkFields()
static Class<? extends Evaluation.Builder>	serializableBuilderClass()
Evaluation.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

complianceResourceType

public final String complianceResourceType()

The type of Amazon Web Services resource that was evaluated.

Returns:

The type of Amazon Web Services resource that was evaluated.

complianceResourceId

public final String complianceResourceId()

The ID of the Amazon Web Services resource that was evaluated.

Returns:

The ID of the Amazon Web Services resource that was evaluated.

complianceType

public final ComplianceType complianceType()

Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

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

Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to 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 Amazon Web Services resource complies with the Config rule that it was evaluated against.

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

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

See Also:

ComplianceType

complianceTypeAsString

public final String complianceTypeAsString()

Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

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

Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to 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 Amazon Web Services resource complies with the Config rule that it was evaluated against.

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

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

See Also:

ComplianceType

annotation

public final String annotation()

Supplementary information about how the evaluation determined the compliance.

Returns:

Supplementary information about how the evaluation determined the compliance.

orderingTimestamp

public final Instant orderingTimestamp()

The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

Returns:

The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

toBuilder

public Evaluation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Evaluation.Builder,Evaluation>

builder

public static Evaluation.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo