software.amazon.awssdk.services.cloudtrail.model

Class EventDataStore

java.lang.Object

software.amazon.awssdk.services.cloudtrail.model.EventDataStore

All Implemented Interfaces:

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

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

A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events that you have logged on your account from the last 90 to 2555 days (about three months to up to seven years). To select events for an event data store, use advanced event selectors.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventDataStore.Builder

Method Summary

Modifier and Type	Method and Description
List<AdvancedEventSelector>	advancedEventSelectors() The advanced event selectors that were used to select events for the data store.
static EventDataStore.Builder	builder()
Instant	createdTimestamp() The timestamp of the event data store's creation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventDataStoreArn() The ARN of the event data store.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdvancedEventSelectors() For responses, this returns true if the service returned a value for the AdvancedEventSelectors property.
int	hashCode()
Boolean	multiRegionEnabled() Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
String	name() The name of the event data store.
Boolean	organizationEnabled() Indicates that an event data store is collecting logged events for an organization.
Integer	retentionPeriod() The retention period, in days.
List<SdkField<?>>	sdkFields()
static Class<? extends EventDataStore.Builder>	serializableBuilderClass()
EventDataStoreStatus	status() The status of an event data store.
String	statusAsString() The status of an event data store.
Boolean	terminationProtectionEnabled() Indicates whether the event data store is protected from termination.
EventDataStore.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedTimestamp() The timestamp showing when an event data store was updated, if applicable.

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 ARN of the event data store.

Returns:

The ARN of the event data store.

name

public final String name()

The name of the event data store.

Returns:

The name of the event data store.

terminationProtectionEnabled

public final Boolean terminationProtectionEnabled()

Indicates whether the event data store is protected from termination.

Returns:

Indicates whether the event data store is protected from termination.

status

public final EventDataStoreStatus status()

The status of an event data store. Values are ENABLED and PENDING_DELETION.

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

Returns:

The status of an event data store. Values are ENABLED and PENDING_DELETION.

See Also:

EventDataStoreStatus

statusAsString

public final String statusAsString()

The status of an event data store. Values are ENABLED and PENDING_DELETION.

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

Returns:

The status of an event data store. Values are ENABLED and PENDING_DELETION.

See Also:

EventDataStoreStatus

hasAdvancedEventSelectors

public final boolean hasAdvancedEventSelectors()

For responses, this returns true if the service returned a value for the AdvancedEventSelectors 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.

advancedEventSelectors

public final List<AdvancedEventSelector> advancedEventSelectors()

The advanced event selectors that were used to select events for the data store.

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 hasAdvancedEventSelectors() method.

Returns:

The advanced event selectors that were used to select events for the data store.

multiRegionEnabled

public final Boolean multiRegionEnabled()

Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

Returns:

Indicates whether the event data store includes events from all regions, or only from the region in which it was created.

organizationEnabled

public final Boolean organizationEnabled()

Indicates that an event data store is collecting logged events for an organization.

Returns:

Indicates that an event data store is collecting logged events for an organization.

retentionPeriod

public final Integer retentionPeriod()

The retention period, in days.

Returns:

The retention period, in days.

createdTimestamp

public final Instant createdTimestamp()

The timestamp of the event data store's creation.

Returns:

The timestamp of the event data store's creation.

updatedTimestamp

public final Instant updatedTimestamp()

The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

Returns:

The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

toBuilder

public EventDataStore.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EventDataStore.Builder,EventDataStore>

builder

public static EventDataStore.Builder builder()

serializableBuilderClass

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