ProcessingConfiguration (AWS CloudTrail Processing Library for Java

All Known Implementing Classes:

ClientConfiguration, PropertiesFileConfiguration
```
public interface ProcessingConfiguration
```
Data used to configure a EventReader.
You can use a system properties file to load the configuration or create a ClientConfiguration object and set each attribute. If you do not provide a value for an attribute, a default value will be provided.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_DELETE_MESSAGE_UPON_FAILURE` Whether to delete SQS messages if there is failure during `SqsManager.parseMessage(List)` and `EventReader.processSource(CloudTrailSource)`; false.
`static boolean`	`DEFAULT_ENABLE_RAW_EVENT_INFO` Whether to enable raw event information in event metadata; false.
`static int`	`DEFAULT_MAX_EVENTS_PER_EMIT` The default number of events accumulated before emitting; 1.
`static int`	`DEFAULT_NUM_OF_PARALLEL_READERS` The default SQS reader thread count
`static java.lang.String`	`DEFAULT_S3_REGION` The default S3 region; "us-east-1".
`static java.lang.String`	`DEFAULT_SQS_REGION` The default SQS region; "us-east-1".
`static int`	`DEFAULT_THREAD_COUNT` The default S3 thread count; 1.
`static int`	`DEFAULT_THREAD_TERMINATION_DELAY_SECONDS` The default thread termination delay, in seconds; 60.
`static int`	`DEFAULT_VISIBILITY_TIMEOUT` The default SQS visibility timeout, in seconds; 60.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AWSCredentialsProvider`	`getAwsCredentialsProvider()` Get the AWS Credentials provider used to access AWS.
`int`	`getMaxEventsPerEmit()` Get the maximum number of AWSCloudTrailClientEvents sent to a single invocation of processEvents().
`int`	`getNumOfParallelReaders()` Get a number of reader threads
`java.lang.String`	`getS3Region()` Get the AWS S3 Region.
`java.lang.String`	`getSqsRegion()` Gets the SQS Region from which CloudTrail logs are obtained.
`java.lang.String`	`getSqsUrl()` Gets the SQS URL used to obtain CloudTrail logs.
`int`	`getThreadCount()` Get the number of threads used to download S3 files in parallel.
`int`	`getThreadTerminationDelaySeconds()` Get the thread termination delay value.
`int`	`getVisibilityTimeout()` Get the visibility timeout value for the SQS queue.
`boolean`	`isDeleteMessageUponFailure()` Indicates whether to delete SQS messages when there is a failure during `SqsManager.parseMessage(List)` and `EventReader.processSource(CloudTrailSource)`.
`boolean`	`isEnableRawEventInfo()` Indicates whether raw event information is returned in `CloudTrailEventMetadata`.
`void`	`validate()` Validate that all necessary parameters are set in the provided configuration.

- Field Detail
  - DEFAULT_SQS_REGION
```
static final java.lang.String DEFAULT_SQS_REGION
```
    The default SQS region; "us-east-1".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_S3_REGION
```
static final java.lang.String DEFAULT_S3_REGION
```
    The default S3 region; "us-east-1".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VISIBILITY_TIMEOUT
```
static final int DEFAULT_VISIBILITY_TIMEOUT
```
    The default SQS visibility timeout, in seconds; 60.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_THREAD_COUNT
```
static final int DEFAULT_THREAD_COUNT
```
    The default S3 thread count; 1.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_NUM_OF_PARALLEL_READERS
```
static final int DEFAULT_NUM_OF_PARALLEL_READERS
```
    The default SQS reader thread count
    
    See Also:
    
    Constant Field Values
  - DEFAULT_THREAD_TERMINATION_DELAY_SECONDS
```
static final int DEFAULT_THREAD_TERMINATION_DELAY_SECONDS
```
    The default thread termination delay, in seconds; 60.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_EVENTS_PER_EMIT
```
static final int DEFAULT_MAX_EVENTS_PER_EMIT
```
    The default number of events accumulated before emitting; 1.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENABLE_RAW_EVENT_INFO
```
static final boolean DEFAULT_ENABLE_RAW_EVENT_INFO
```
    Whether to enable raw event information in event metadata; false.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DELETE_MESSAGE_UPON_FAILURE
```
static final boolean DEFAULT_DELETE_MESSAGE_UPON_FAILURE
```
    Whether to delete SQS messages if there is failure during SqsManager.parseMessage(List) and EventReader.processSource(CloudTrailSource); false.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAwsCredentialsProvider
```
AWSCredentialsProvider getAwsCredentialsProvider()
```
    Get the AWS Credentials provider used to access AWS.
    
    Returns:
    
    an AWSCredentialsProvider object.
  - getSqsUrl
```
java.lang.String getSqsUrl()
```
    Gets the SQS URL used to obtain CloudTrail logs.
    
    Returns:
    
    the configured SQS URL used to get CloudTrail logs.
  - getSqsRegion
```
java.lang.String getSqsRegion()
```
    Gets the SQS Region from which CloudTrail logs are obtained.
    
    Returns:
    
    the SQS Region
  - getVisibilityTimeout
```
int getVisibilityTimeout()
```
    Get the visibility timeout value for the SQS queue.
    The period of time during which Amazon SQS prevents other consuming components from receiving and processing a message.
    
    Returns:
    
    the visibility timeout value.
  - getS3Region
```
java.lang.String getS3Region()
```
    Get the AWS S3 Region.
    
    Returns:
    
    the Amazon S3 region used.
  - getThreadCount
```
int getThreadCount()
```
    Get the number of threads used to download S3 files in parallel.
    
    Returns:
    
    the number of threads.
  - getNumOfParallelReaders
```
int getNumOfParallelReaders()
```
    Get a number of reader threads
    
    Returns:
  - getThreadTerminationDelaySeconds
```
int getThreadTerminationDelaySeconds()
```
    Get the thread termination delay value.
    
    Returns:
    
    the thread termination delay, in seconds.
  - getMaxEventsPerEmit
```
int getMaxEventsPerEmit()
```
    Get the maximum number of AWSCloudTrailClientEvents sent to a single invocation of processEvents().
    
    Returns:
    
    the maximum number of events that will be buffered per call to processEvents.
  - isEnableRawEventInfo
```
boolean isEnableRawEventInfo()
```
    Indicates whether raw event information is returned in CloudTrailEventMetadata.
    
    Returns:
    
    true if raw event information is enabled; false otherwise.
  - isDeleteMessageUponFailure
```
boolean isDeleteMessageUponFailure()
```
    Indicates whether to delete SQS messages when there is a failure during SqsManager.parseMessage(List) and EventReader.processSource(CloudTrailSource). The SQS message will be deleted upon success regardless of the setting for deleteMessageUponFailure.
    
    Returns:
    
    true if delete SQS message upon failure is enabled. Otherwise, false.
  - validate
```
void validate()
```
    Validate that all necessary parameters are set in the provided configuration.
    This method throws an exception if any of the required parameters are null.
    
    Throws:
    
    java.lang.IllegalStateException - if any parameters are null.

Interface ProcessingConfiguration

Field Summary

Method Summary

Field Detail

DEFAULT_SQS_REGION

DEFAULT_S3_REGION

DEFAULT_VISIBILITY_TIMEOUT

DEFAULT_THREAD_COUNT

DEFAULT_NUM_OF_PARALLEL_READERS

DEFAULT_THREAD_TERMINATION_DELAY_SECONDS

DEFAULT_MAX_EVENTS_PER_EMIT

DEFAULT_ENABLE_RAW_EVENT_INFO

DEFAULT_DELETE_MESSAGE_UPON_FAILURE

Method Detail

getAwsCredentialsProvider

getSqsUrl

getSqsRegion

getVisibilityTimeout

getS3Region

getThreadCount

getNumOfParallelReaders

getThreadTerminationDelaySeconds

getMaxEventsPerEmit

isEnableRawEventInfo

isDeleteMessageUponFailure

validate