software.amazon.awssdk.services.config.model

Class AggregateEvaluationResult

java.lang.Object

software.amazon.awssdk.services.config.model.AggregateEvaluationResult

All Implemented Interfaces:

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

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

The details of an AWS Config evaluation for an account ID and region in an aggregator. Provides the AWS resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AggregateEvaluationResult.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The 12-digit account ID of the source account.
String	annotation() Supplementary information about how the agrregate evaluation determined the compliance.
String	awsRegion() The source region from where the data is aggregated.
static AggregateEvaluationResult.Builder	builder()
ComplianceType	complianceType() The resource compliance status.
String	complianceTypeAsString() The resource compliance status.
Instant	configRuleInvokedTime() The time when the AWS Config rule evaluated the AWS resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
EvaluationResultIdentifier	evaluationResultIdentifier() Uniquely identifies the evaluation result.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	resultRecordedTime() The time when AWS Config recorded the aggregate evaluation result.
List<SdkField<?>>	sdkFields()
static Class<? extends AggregateEvaluationResult.Builder>	serializableBuilderClass()
AggregateEvaluationResult.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

evaluationResultIdentifier

public final EvaluationResultIdentifier evaluationResultIdentifier()

Uniquely identifies the evaluation result.

Returns:

Uniquely identifies the evaluation result.

complianceType

public final ComplianceType complianceType()

The resource compliance status.

For the AggregationEvaluationResult data type, AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.

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:

The resource compliance status.

For the AggregationEvaluationResult data type, AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.

See Also:

ComplianceType

complianceTypeAsString

public final String complianceTypeAsString()

The resource compliance status.

For the AggregationEvaluationResult data type, AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.

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:

The resource compliance status.

For the AggregationEvaluationResult data type, AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.

See Also:

ComplianceType

resultRecordedTime

public final Instant resultRecordedTime()

The time when AWS Config recorded the aggregate evaluation result.

Returns:

The time when AWS Config recorded the aggregate evaluation result.

configRuleInvokedTime

public final Instant configRuleInvokedTime()

The time when the AWS Config rule evaluated the AWS resource.

Returns:

The time when the AWS Config rule evaluated the AWS resource.

annotation

public final String annotation()

Supplementary information about how the agrregate evaluation determined the compliance.

Returns:

Supplementary information about how the agrregate evaluation determined the compliance.

accountId

public final String accountId()

The 12-digit account ID of the source account.

Returns:

The 12-digit account ID of the source account.

awsRegion

public final String awsRegion()

The source region from where the data is aggregated.

Returns:

The source region from where the data is aggregated.

toBuilder

public AggregateEvaluationResult.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<AggregateEvaluationResult.Builder,AggregateEvaluationResult>

Returns:

a builder for type T

builder

public static AggregateEvaluationResult.Builder builder()

serializableBuilderClass

public static Class<? extends AggregateEvaluationResult.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.