Class AggregateConformancePackCompliance

java.lang.Object
software.amazon.awssdk.services.config.model.AggregateConformancePackCompliance
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AggregateConformancePackCompliance.Builder,AggregateConformancePackCompliance>
@Generated("software.amazon.awssdk:codegen") public final class AggregateConformancePackCompliance extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AggregateConformancePackCompliance.Builder,AggregateConformancePackCompliance>

Provides the number of compliant and noncompliant rules within a conformance pack. Also provides the compliance status of the conformance pack and the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.

See Also:

  • Method Details

    • complianceType

      public final ConformancePackComplianceType complianceType()

      The compliance status of the conformance pack.

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

      Returns:
      The compliance status of the conformance pack.
      See Also:

    • complianceTypeAsString

      public final String complianceTypeAsString()

      The compliance status of the conformance pack.

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

      Returns:
      The compliance status of the conformance pack.
      See Also:

    • compliantRuleCount

      public final Integer compliantRuleCount()

      The number of compliant Config Rules.

      Returns:
      The number of compliant Config Rules.

    • nonCompliantRuleCount

      public final Integer nonCompliantRuleCount()

      The number of noncompliant Config Rules.

      Returns:
      The number of noncompliant Config Rules.

    • totalRuleCount

      public final Integer totalRuleCount()

      Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.

      Returns:
      Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.

    • toBuilder

      public AggregateConformancePackCompliance.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<AggregateConformancePackCompliance.Builder,AggregateConformancePackCompliance>
      Returns:
      a builder for type T

    • builder

      public static AggregateConformancePackCompliance.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.