Package software.amazon.awssdk.services.securitylake.model

Class CreateCustomLogSourceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.securitylake.model.SecurityLakeRequest

software.amazon.awssdk.services.securitylake.model.CreateCustomLogSourceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCustomLogSourceRequest.Builder,CreateCustomLogSourceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateCustomLogSourceRequest
extends SecurityLakeRequest
implements ToCopyableBuilder<CreateCustomLogSourceRequest.Builder,CreateCustomLogSourceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateCustomLogSourceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateCustomLogSourceRequest.Builder	builder()
CustomLogSourceConfiguration	configuration()	The configuration used for the third-party custom source.
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()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCustomLogSourceRequest.Builder>	serializableBuilderClass()
String	sourceName()	Specify the name for a third-party custom source.
String	sourceVersion()	Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.
CreateCustomLogSourceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

configuration

public final CustomLogSourceConfiguration configuration()

The configuration used for the third-party custom source.

Returns:

The configuration used for the third-party custom source.

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. For the list of supported event classes, see the Amazon Security Lake User Guide.

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. For the list of supported event classes, see the Amazon Security Lake User Guide.

sourceName

public final String sourceName()

Specify the name for a third-party custom source. This must be a Regionally unique value. The sourceName you enter here, is used in the LogProviderRole name which follows the convention AmazonSecurityLake-Provider-{name of the custom source}-{region}. You must use a CustomLogSource name that is shorter than or equal to 20 characters. This ensures that the LogProviderRole name is below the 64 character limit.

Returns:

Specify the name for a third-party custom source. This must be a Regionally unique value. The sourceName you enter here, is used in the LogProviderRole name which follows the convention AmazonSecurityLake-Provider-{name of the custom source}-{region}. You must use a CustomLogSource name that is shorter than or equal to 20 characters. This ensures that the LogProviderRole name is below the 64 character limit.

sourceVersion

public final String sourceVersion()

Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.

Returns:

Specify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.

toBuilder

public CreateCustomLogSourceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCustomLogSourceRequest.Builder,CreateCustomLogSourceRequest>

Specified by:

toBuilder in class SecurityLakeRequest

builder

public static CreateCustomLogSourceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCustomLogSourceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo