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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceEvidence.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringassessmentReportSelection()Specifies whether the evidence is included in the assessment report.Map<String,String>attributes()The names and values that are used by the evidence event.StringawsAccountId()The identifier for the Amazon Web Services account.StringawsOrganization()The Amazon Web Services account that the evidence is collected from, and its organization path.static Evidence.Builderbuilder()StringcomplianceCheck()The evaluation status for automated evidence that falls under the compliance check category.StringdataSource()The data source where the evidence was collected from.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeventName()The name of the evidence event.StringeventSource()The Amazon Web Service that the evidence is collected from.StringevidenceAwsAccountId()The identifier for the Amazon Web Services account.StringevidenceByType()The type of automated evidence.StringevidenceFolderId()The identifier for the folder that the evidence is stored in.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAttributes()For responses, this returns true if the service returned a value for the Attributes property.inthashCode()booleanhasResourcesIncluded()For responses, this returns true if the service returned a value for the ResourcesIncluded property.StringiamId()The unique identifier for the user or role that's associated with the evidence.Stringid()The identifier for the evidence.List<Resource>resourcesIncluded()The list of resources that are assessed to generate the evidence.List<SdkField<?>>sdkFields()static Class<? extends Evidence.Builder>serializableBuilderClass()Instanttime()The timestamp that represents when the evidence was collected.Evidence.BuildertoBuilder()StringtoString()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
-
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 theisEmpty()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 theisEmpty()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 astrueorfalse).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 astrueorfalse).
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Evidence.Builder,Evidence>
-
builder
public static Evidence.Builder builder()
-
serializableBuilderClass
public static Class<? extends Evidence.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-