software.amazon.awssdk.services.auditmanager.model

Class EvidenceFinderEnablement

java.lang.Object

software.amazon.awssdk.services.auditmanager.model.EvidenceFinderEnablement

All Implemented Interfaces:

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

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

The settings object that specifies whether evidence finder is enabled. This object also describes the related event data store, and the backfill status for populating the event data store with evidence data.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EvidenceFinderEnablement.Builder

Method Summary

Modifier and Type	Method and Description
EvidenceFinderBackfillStatus	backfillStatus() The current status of the evidence data backfill process.
String	backfillStatusAsString() The current status of the evidence data backfill process.
static EvidenceFinderEnablement.Builder	builder()
EvidenceFinderEnablementStatus	enablementStatus() The current status of the evidence finder feature and the related event data store.
String	enablementStatusAsString() The current status of the evidence finder feature and the related event data store.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	error() Represents any errors that occurred when enabling or disabling evidence finder.
String	eventDataStoreArn() The Amazon Resource Name (ARN) of the CloudTrail Lake event data store that’s used by evidence finder.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends EvidenceFinderEnablement.Builder>	serializableBuilderClass()
EvidenceFinderEnablement.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

eventDataStoreArn

public final String eventDataStoreArn()

The Amazon Resource Name (ARN) of the CloudTrail Lake event data store that’s used by evidence finder. The event data store is the lake of evidence data that evidence finder runs queries against.

Returns:

The Amazon Resource Name (ARN) of the CloudTrail Lake event data store that’s used by evidence finder. The event data store is the lake of evidence data that evidence finder runs queries against.

enablementStatus

public final EvidenceFinderEnablementStatus enablementStatus()

The current status of the evidence finder feature and the related event data store.

• ENABLE_IN_PROGRESS means that you requested to enable evidence finder. An event data store is currently being created to support evidence finder queries.

• ENABLED means that an event data store was successfully created and evidence finder is enabled. We recommend that you wait 7 days until the event data store is backfilled with your past two years’ worth of evidence data. You can use evidence finder in the meantime, but not all data might be available until the backfill is complete.

• DISABLE_IN_PROGRESS means that you requested to disable evidence finder, and your request is pending the deletion of the event data store.

• DISABLED means that you have permanently disabled evidence finder and the event data store has been deleted. You can't re-enable evidence finder after this point.

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

Returns:

The current status of the evidence finder feature and the related event data store.

• ENABLE_IN_PROGRESS means that you requested to enable evidence finder. An event data store is currently being created to support evidence finder queries.

• ENABLED means that an event data store was successfully created and evidence finder is enabled. We recommend that you wait 7 days until the event data store is backfilled with your past two years’ worth of evidence data. You can use evidence finder in the meantime, but not all data might be available until the backfill is complete.

• DISABLE_IN_PROGRESS means that you requested to disable evidence finder, and your request is pending the deletion of the event data store.

• DISABLED means that you have permanently disabled evidence finder and the event data store has been deleted. You can't re-enable evidence finder after this point.

See Also:

EvidenceFinderEnablementStatus

enablementStatusAsString

public final String enablementStatusAsString()

The current status of the evidence finder feature and the related event data store.

• ENABLE_IN_PROGRESS means that you requested to enable evidence finder. An event data store is currently being created to support evidence finder queries.

• ENABLED means that an event data store was successfully created and evidence finder is enabled. We recommend that you wait 7 days until the event data store is backfilled with your past two years’ worth of evidence data. You can use evidence finder in the meantime, but not all data might be available until the backfill is complete.

• DISABLE_IN_PROGRESS means that you requested to disable evidence finder, and your request is pending the deletion of the event data store.

• DISABLED means that you have permanently disabled evidence finder and the event data store has been deleted. You can't re-enable evidence finder after this point.

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

Returns:

The current status of the evidence finder feature and the related event data store.

• ENABLE_IN_PROGRESS means that you requested to enable evidence finder. An event data store is currently being created to support evidence finder queries.

• ENABLED means that an event data store was successfully created and evidence finder is enabled. We recommend that you wait 7 days until the event data store is backfilled with your past two years’ worth of evidence data. You can use evidence finder in the meantime, but not all data might be available until the backfill is complete.

• DISABLE_IN_PROGRESS means that you requested to disable evidence finder, and your request is pending the deletion of the event data store.

• DISABLED means that you have permanently disabled evidence finder and the event data store has been deleted. You can't re-enable evidence finder after this point.

See Also:

EvidenceFinderEnablementStatus

backfillStatus

public final EvidenceFinderBackfillStatus backfillStatus()

The current status of the evidence data backfill process.

The backfill starts after you enable evidence finder. During this task, Audit Manager populates an event data store with your past two years’ worth of evidence data so that your evidence can be queried.

• NOT_STARTED means that the backfill hasn’t started yet.

• IN_PROGRESS means that the backfill is in progress. This can take up to 7 days to complete, depending on the amount of evidence data.

• COMPLETED means that the backfill is complete. All of your past evidence is now queryable.

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

Returns:

The current status of the evidence data backfill process.

The backfill starts after you enable evidence finder. During this task, Audit Manager populates an event data store with your past two years’ worth of evidence data so that your evidence can be queried.

• NOT_STARTED means that the backfill hasn’t started yet.

• IN_PROGRESS means that the backfill is in progress. This can take up to 7 days to complete, depending on the amount of evidence data.

• COMPLETED means that the backfill is complete. All of your past evidence is now queryable.

See Also:

EvidenceFinderBackfillStatus

backfillStatusAsString

public final String backfillStatusAsString()

The current status of the evidence data backfill process.

The backfill starts after you enable evidence finder. During this task, Audit Manager populates an event data store with your past two years’ worth of evidence data so that your evidence can be queried.

• NOT_STARTED means that the backfill hasn’t started yet.

• IN_PROGRESS means that the backfill is in progress. This can take up to 7 days to complete, depending on the amount of evidence data.

• COMPLETED means that the backfill is complete. All of your past evidence is now queryable.

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

Returns:

The current status of the evidence data backfill process.

The backfill starts after you enable evidence finder. During this task, Audit Manager populates an event data store with your past two years’ worth of evidence data so that your evidence can be queried.

• NOT_STARTED means that the backfill hasn’t started yet.

• IN_PROGRESS means that the backfill is in progress. This can take up to 7 days to complete, depending on the amount of evidence data.

• COMPLETED means that the backfill is complete. All of your past evidence is now queryable.

See Also:

EvidenceFinderBackfillStatus

error

public final String error()

Represents any errors that occurred when enabling or disabling evidence finder.

Returns:

Represents any errors that occurred when enabling or disabling evidence finder.

toBuilder

public EvidenceFinderEnablement.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EvidenceFinderEnablement.Builder,EvidenceFinderEnablement>

builder

public static EvidenceFinderEnablement.Builder builder()

serializableBuilderClass

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