software.amazon.awssdk.services.securitylake.model

Class DataLakeSource

java.lang.Object

software.amazon.awssdk.services.securitylake.model.DataLakeSource

All Implemented Interfaces:

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

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

Amazon Security Lake collects logs and events from supported Amazon Web Services and custom sources. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DataLakeSource.Builder

Method Summary

Modifier and Type	Method and Description
String	account() The ID of the Security Lake account for which logs are collected.
static DataLakeSource.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	eventClasses() The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEventClasses() For responses, this returns true if the service returned a value for the EventClasses property.
int	hashCode()
boolean	hasSourceStatuses() For responses, this returns true if the service returned a value for the SourceStatuses property.
List<SdkField<?>>	sdkFields()
static Class<? extends DataLakeSource.Builder>	serializableBuilderClass()
String	sourceName() The supported Amazon Web Services from which logs and events are collected.
List<DataLakeSourceStatus>	sourceStatuses() The log status for the Security Lake account.
DataLakeSource.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

account

public final String account()

The ID of the Security Lake account for which logs are collected.

Returns:

The ID of the Security Lake account for which logs are collected.

hasEventClasses

public final boolean hasEventClasses()

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

eventClasses

public final List<String> eventClasses()

The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. The supported event classes are:

• ACCESS_ACTIVITY

• FILE_ACTIVITY

• KERNEL_ACTIVITY

• KERNEL_EXTENSION

• MEMORY_ACTIVITY

• MODULE_ACTIVITY

• PROCESS_ACTIVITY

• REGISTRY_KEY_ACTIVITY

• REGISTRY_VALUE_ACTIVITY

• RESOURCE_ACTIVITY

• SCHEDULED_JOB_ACTIVITY

• SECURITY_FINDING

• ACCOUNT_CHANGE

• AUTHENTICATION

• AUTHORIZATION

• ENTITY_MANAGEMENT_AUDIT

• DHCP_ACTIVITY

• NETWORK_ACTIVITY

• DNS_ACTIVITY

• FTP_ACTIVITY

• HTTP_ACTIVITY

• RDP_ACTIVITY

• SMB_ACTIVITY

• SSH_ACTIVITY

• CONFIG_STATE

• INVENTORY_INFO

• EMAIL_ACTIVITY

• API_ACTIVITY

• CLOUD_API

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

Returns:

The Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. The supported event classes are:

• ACCESS_ACTIVITY

• FILE_ACTIVITY

• KERNEL_ACTIVITY

• KERNEL_EXTENSION

• MEMORY_ACTIVITY

• MODULE_ACTIVITY

• PROCESS_ACTIVITY

• REGISTRY_KEY_ACTIVITY

• REGISTRY_VALUE_ACTIVITY

• RESOURCE_ACTIVITY

• SCHEDULED_JOB_ACTIVITY

• SECURITY_FINDING

• ACCOUNT_CHANGE

• AUTHENTICATION

• AUTHORIZATION

• ENTITY_MANAGEMENT_AUDIT

• DHCP_ACTIVITY

• NETWORK_ACTIVITY

• DNS_ACTIVITY

• FTP_ACTIVITY

• HTTP_ACTIVITY

• RDP_ACTIVITY

• SMB_ACTIVITY

• SSH_ACTIVITY

• CONFIG_STATE

• INVENTORY_INFO

• EMAIL_ACTIVITY

• API_ACTIVITY

• CLOUD_API

sourceName

public final String sourceName()

The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

Returns:

The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.

hasSourceStatuses

public final boolean hasSourceStatuses()

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

sourceStatuses

public final List<DataLakeSourceStatus> sourceStatuses()

The log status for the Security Lake account.

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

Returns:

The log status for the Security Lake account.

toBuilder

public DataLakeSource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DataLakeSource.Builder,DataLakeSource>

builder

public static DataLakeSource.Builder builder()

serializableBuilderClass

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