Package software.amazon.awssdk.services.auditmanager.model

Class Evidence

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

A record that contains the information needed to demonstrate compliance with the requirements specified by a control. Examples of evidence include change activity invoked by a user, or a system configuration snapshot.

See Also:

  • Method Details

    • dataSource

      public final String dataSource()

      The data source where the evidence was collected from.

      Returns:
      The data source where the evidence was collected from.

    • evidenceAwsAccountId

      public final String evidenceAwsAccountId()

      The identifier for the Amazon Web Services account.

      Returns:
      The identifier for the Amazon Web Services account.

    • time

      public final Instant time()

      The timestamp that represents when the evidence was collected.

      Returns:
      The timestamp that represents when the evidence was collected.

    • eventSource

      public final String eventSource()

      The Amazon Web Service that the evidence is collected from.

      Returns:
      The Amazon Web Service that the evidence is collected from.

    • eventName

      public final String eventName()

      The name of the evidence event.

      Returns:
      The name of the evidence event.

    • evidenceByType

      public final String evidenceByType()

      The type of automated evidence.

      Returns:
      The type of automated evidence.

    • hasResourcesIncluded

      public final boolean hasResourcesIncluded()
      For responses, this returns true if the service returned a value for the ResourcesIncluded property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • resourcesIncluded

      public final List<Resource> resourcesIncluded()

      The list of resources that are assessed to generate the evidence.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourcesIncluded() method.

      Returns:
      The list of resources that are assessed to generate the evidence.

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • attributes

      public final Map<String,String> attributes()

      The names and values that are used by the evidence event. This includes an attribute name (such as allowUsersToChangePassword) and value (such as true or false).

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAttributes() method.

      Returns:
      The names and values that are used by the evidence event. This includes an attribute name (such as allowUsersToChangePassword) and value (such as true or false).

    • iamId

      public final String iamId()

      The unique identifier for the user or role that's associated with the evidence.

      Returns:
      The unique identifier for the user or role that's associated with the evidence.

    • complianceCheck

      public final String complianceCheck()

      The evaluation status for automated evidence that falls under the compliance check category.

      • Audit Manager classes evidence as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result.

      • Audit Manager classes evidence as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result.

      • If a compliance check isn't available or applicable, then no compliance evaluation can be made for that evidence. This is the case if the evidence uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the evidence uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail).

      Returns:
      The evaluation status for automated evidence that falls under the compliance check category.

      • Audit Manager classes evidence as non-compliant if Security Hub reports a Fail result, or if Config reports a Non-compliant result.

      • Audit Manager classes evidence as compliant if Security Hub reports a Pass result, or if Config reports a Compliant result.

      • If a compliance check isn't available or applicable, then no compliance evaluation can be made for that evidence. This is the case if the evidence uses Config or Security Hub as the underlying data source type, but those services aren't enabled. This is also the case if the evidence uses an underlying data source type that doesn't support compliance checks (such as manual evidence, Amazon Web Services API calls, or CloudTrail).

    • awsOrganization

      public final String awsOrganization()

      The Amazon Web Services account that the evidence is collected from, and its organization path.

      Returns:
      The Amazon Web Services account that the evidence is collected from, and its organization path.

    • awsAccountId

      public final String awsAccountId()

      The identifier for the Amazon Web Services account.

      Returns:
      The identifier for the Amazon Web Services account.

    • evidenceFolderId

      public final String evidenceFolderId()

      The identifier for the folder that the evidence is stored in.

      Returns:
      The identifier for the folder that the evidence is stored in.

    • id

      public final String id()

      The identifier for the evidence.

      Returns:
      The identifier for the evidence.

    • assessmentReportSelection

      public final String assessmentReportSelection()

      Specifies whether the evidence is included in the assessment report.

      Returns:
      Specifies whether the evidence is included in the assessment report.

    • toBuilder

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

    • builder

      public static Evidence.Builder builder()

    • serializableBuilderClass

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