ClientConfiguration (AWS CloudTrail Processing Library for Java

java.lang.Object
- com.amazonaws.services.cloudtrail.processinglibrary.configuration.ClientConfiguration

All Implemented Interfaces:

ProcessingConfiguration
```
public class ClientConfiguration
extends java.lang.Object
implements ProcessingConfiguration
```
Defines a basic processing configuration for the AWS CloudTrail Processing Library. You can use instances of this class to configure an AWSCloudTrailProcessingExecutor as an alternative to using a class path properties file.

Field Summary

Fields
Modifier and Type	Field and Description
`AWSCredentialsProvider`	`awsCredentialsProvider` The AWS credentials provider used to obtain credentials.
`boolean`	`deleteMessageUponFailure` whether or not to delete SQS messages when there is any failure during `SqsManager.parseMessage(List)` and `EventReader.processSource(CloudTrailSource)`.
`boolean`	`enableRawEventInfo` Whether to include raw event information in `CloudTrailEventMetadata`.
`int`	`maxEventsPerEmit` The maximum number of AWSCloudTrailClientEvents sent to a single invocation of processEvents().
`int`	`numOfParallelReaders` The number of SQS reader threads
`java.lang.String`	`s3Region` The S3 endpoint specific to a region.
`java.lang.String`	`sqsRegion` The SQS region to use.
`java.lang.String`	`sqsUrl` The SQS Queue URL used to receive events.
`int`	`threadCount` The number of threads used to download log files from S3 in parallel.
`int`	`threadTerminationDelaySeconds` The time allowed, in seconds, for threads to shut down after `AWSCloudTrailProcessingExecutor.stop()` is called.
`int`	`visibilityTimeout` A period of time, in seconds, during which Amazon SQS prevents other consuming components from receiving and processing messages that are currently being processed by the CloudTrail Processing Library on your behalf.

Fields inherited from interface com.amazonaws.services.cloudtrail.processinglibrary.configuration.ProcessingConfiguration
DEFAULT_DELETE_MESSAGE_UPON_FAILURE, DEFAULT_ENABLE_RAW_EVENT_INFO, DEFAULT_MAX_EVENTS_PER_EMIT, DEFAULT_NUM_OF_PARALLEL_READERS, DEFAULT_S3_REGION, DEFAULT_SQS_REGION, DEFAULT_THREAD_COUNT, DEFAULT_THREAD_TERMINATION_DELAY_SECONDS, DEFAULT_VISIBILITY_TIMEOUT

Constructor Summary

Constructors
Constructor and Description
`ClientConfiguration(java.lang.String sqsUrl, AWSCredentialsProvider awsCredentialsProvider)` Initializes a new `ClientConfiguration`.

Method Summary

All Methods Instance Methods Concrete 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`	`setAwsCredentialsProvider(AWSCredentialsProvider awsCredentialsProvider)` Set the AWS Credentials Provider used to access AWS.
`void`	`setDeleteMessageUponFailure(boolean deleteMessageUponFailure)` Set whether or not to delete SQS messages when there is any failure during `SqsManager.parseMessage(List)` and `EventReader.processSource(CloudTrailSource)`.
`void`	`setEnableRawEventInfo(boolean enableRawEventInfo)` Set whether or not raw event information should be returned in `CloudTrailEventMetadata`.
`void`	`setMaxEventsPerEmit(int maxEventsPerEmit)` Set the maximum number of events that can be buffered per call to `processEvents()`.
`void`	`setNumOfParallelReaders(int numOfParallelReaders)` The number of reader threads that pull messages from the SQS
`void`	`setS3Region(java.lang.String s3Region)` The S3 endpoint specific to a region.
`void`	`setSqsRegion(java.lang.String sqsRegion)` Sets the SQS Region to use to get CloudTrail logs.
`void`	`setThreadCount(int threadCount)` The number of threads used to download log files from S3 in parallel.
`void`	`setThreadTerminationDelaySeconds(int threadTerminationDelaySeconds)` Set the time allowed, in seconds, for threads to shut down after `AWSCloudTrailProcessingExecutor.stop()` is called.
`void`	`setVisibilityTimeout(int visibilityTimeout)` Sets the SQS visibility timeout, during which SQS ignores other requests for the message.
`void`	`validate()` Validate that all necessary parameters are set in the provided configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - awsCredentialsProvider
```
public AWSCredentialsProvider awsCredentialsProvider
```
    The AWS credentials provider used to obtain credentials.
  - sqsUrl
```
public java.lang.String sqsUrl
```
    The SQS Queue URL used to receive events.
    The Queue must be subscribed to AWS CloudTrail.
  - sqsRegion
```
public java.lang.String sqsRegion
```
    The SQS region to use.
    If not specified, the will be used.
  - visibilityTimeout
```
public int visibilityTimeout
```
    A period of time, in seconds, during which Amazon SQS prevents other consuming components from receiving and processing messages that are currently being processed by the CloudTrail Processing Library on your behalf.
  - s3Region
```
public java.lang.String s3Region
```
    The S3 endpoint specific to a region.
    If not specified, the will be used.
  - threadCount
```
public int threadCount
```
    The number of threads used to download log files from S3 in parallel.
    Callbacks can be invoked from any thread.
  - numOfParallelReaders
```
public int numOfParallelReaders
```
    The number of SQS reader threads
  - threadTerminationDelaySeconds
```
public int threadTerminationDelaySeconds
```
    The time allowed, in seconds, for threads to shut down after AWSCloudTrailProcessingExecutor.stop() is called.
    Any threads still running beyond this time will be forcibly terminated.
  - maxEventsPerEmit
```
public int maxEventsPerEmit
```
    The maximum number of AWSCloudTrailClientEvents sent to a single invocation of processEvents().
  - enableRawEventInfo
```
public boolean enableRawEventInfo
```
    Whether to include raw event information in CloudTrailEventMetadata.
  - deleteMessageUponFailure
```
public boolean deleteMessageUponFailure
```
    whether or not to delete SQS messages when there is any failure during SqsManager.parseMessage(List) and EventReader.processSource(CloudTrailSource).
- Constructor Detail
  - ClientConfiguration
```
public ClientConfiguration(java.lang.String sqsUrl,
                           AWSCredentialsProvider awsCredentialsProvider)
```
    Initializes a new ClientConfiguration.
    Both parameters are required.
    
    Parameters:
    
    sqsUrl - the SQS URL to use to get CloudTrail events.
    
    awsCredentialsProvider - The AWS Credentials provider to use to obtain AWS access credentials.
    
    See Also:
    
    Queue and Message Identifiers, AWSCredentialsProvider
- Method Detail
  - getAwsCredentialsProvider
```
public AWSCredentialsProvider getAwsCredentialsProvider()
```
    Get the AWS Credentials provider used to access AWS.
    
    Specified by:
    
    getAwsCredentialsProvider in interface ProcessingConfiguration
    
    Returns:
    
    an AWSCredentialsProvider object.
  - getSqsUrl
```
public java.lang.String getSqsUrl()
```
    Gets the SQS URL used to obtain CloudTrail logs.
    
    Specified by:
    
    getSqsUrl in interface ProcessingConfiguration
    
    Returns:
    
    the configured SQS URL used to get CloudTrail logs.
  - getSqsRegion
```
public java.lang.String getSqsRegion()
```
    Gets the SQS Region from which CloudTrail logs are obtained.
    
    Specified by:
    
    getSqsRegion in interface ProcessingConfiguration
    
    Returns:
    
    the SQS Region
  - getVisibilityTimeout
```
public 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.
    
    Specified by:
    
    getVisibilityTimeout in interface ProcessingConfiguration
    
    Returns:
    
    the visibility timeout value.
  - getS3Region
```
public java.lang.String getS3Region()
```
    Get the AWS S3 Region.
    
    Specified by:
    
    getS3Region in interface ProcessingConfiguration
    
    Returns:
    
    the Amazon S3 region used.
  - getThreadCount
```
public int getThreadCount()
```
    Get the number of threads used to download S3 files in parallel.
    
    Specified by:
    
    getThreadCount in interface ProcessingConfiguration
    
    Returns:
    
    the number of threads.
  - getNumOfParallelReaders
```
public int getNumOfParallelReaders()
```
    Get a number of reader threads
    
    Specified by:
    
    getNumOfParallelReaders in interface ProcessingConfiguration
    
    Returns:
  - getThreadTerminationDelaySeconds
```
public int getThreadTerminationDelaySeconds()
```
    Get the thread termination delay value.
    
    Specified by:
    
    getThreadTerminationDelaySeconds in interface ProcessingConfiguration
    
    Returns:
    
    the thread termination delay, in seconds.
  - getMaxEventsPerEmit
```
public int getMaxEventsPerEmit()
```
    Get the maximum number of AWSCloudTrailClientEvents sent to a single invocation of processEvents().
    
    Specified by:
    
    getMaxEventsPerEmit in interface ProcessingConfiguration
    
    Returns:
    
    the maximum number of events that will be buffered per call to processEvents.
  - isEnableRawEventInfo
```
public boolean isEnableRawEventInfo()
```
    Indicates whether raw event information is returned in CloudTrailEventMetadata.
    
    Specified by:
    
    isEnableRawEventInfo in interface ProcessingConfiguration
    
    Returns:
    
    true if raw event information is enabled; false otherwise.
  - isDeleteMessageUponFailure
```
public 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.
    
    Specified by:
    
    isDeleteMessageUponFailure in interface ProcessingConfiguration
    
    Returns:
    
    true if delete SQS message upon failure is enabled. Otherwise, false.
  - validate
```
public 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.
    
    Specified by:
    
    validate in interface ProcessingConfiguration
  - setAwsCredentialsProvider
```
public void setAwsCredentialsProvider(AWSCredentialsProvider awsCredentialsProvider)
```
    Set the AWS Credentials Provider used to access AWS.
    
    Parameters:
    
    awsCredentialsProvider - the AWSCredentialsProvider to set.
  - setSqsRegion
```
public void setSqsRegion(java.lang.String sqsRegion)
```
    Sets the SQS Region to use to get CloudTrail logs.
    
    Parameters:
    
    sqsRegion - the AWS region to use.
  - setVisibilityTimeout
```
public void setVisibilityTimeout(int visibilityTimeout)
```
    Sets the SQS visibility timeout, during which SQS ignores other requests for the message.
    
    Parameters:
    
    visibilityTimeout - the duration, in seconds, to ignore other requests for SQS messages being processed by the AWS CloudTrail Processing Library.
  - setS3Region
```
public void setS3Region(java.lang.String s3Region)
```
    The S3 endpoint specific to a region.
    If not specified, the default S3 region will be used.
    
    Parameters:
    
    s3Region - the s3Region to set
  - setThreadCount
```
public void setThreadCount(int threadCount)
```
    The number of threads used to download log files from S3 in parallel.
    Callbacks can be invoked from any thread.
    
    Parameters:
    
    threadCount - the number of threads to set.
  - setNumOfParallelReaders
```
public void setNumOfParallelReaders(int numOfParallelReaders)
```
    The number of reader threads that pull messages from the SQS
    
    Parameters:
    
    numOfParallelReaders -
  - setThreadTerminationDelaySeconds
```
public void setThreadTerminationDelaySeconds(int threadTerminationDelaySeconds)
```
    Set the time allowed, in seconds, for threads to shut down after AWSCloudTrailProcessingExecutor.stop() is called.
    Any threads still running beyond this time will be forcibly terminated.
    
    Parameters:
    
    threadTerminationDelaySeconds - the termination delay, in seconds, to set.
  - setMaxEventsPerEmit
```
public void setMaxEventsPerEmit(int maxEventsPerEmit)
```
    Set the maximum number of events that can be buffered per call to processEvents().
    Fewer events than this may be sent; this number represents only the maximum.
    
    Parameters:
    
    maxEventsPerEmit - the maximum number of events to buffer.
  - setEnableRawEventInfo
```
public void setEnableRawEventInfo(boolean enableRawEventInfo)
```
    Set whether or not raw event information should be returned in CloudTrailEventMetadata.
    
    Parameters:
    
    enableRawEventInfo - set to true to enable raw event information.
  - setDeleteMessageUponFailure
```
public void setDeleteMessageUponFailure(boolean deleteMessageUponFailure)
```
    Set whether or not to delete SQS messages when there is any failure during SqsManager.parseMessage(List) and EventReader.processSource(CloudTrailSource). The SQS message will be deleted upon success regardless the setting of deleteMessageUponFailure.
    
    Parameters:
    
    deleteMessageUponFailure - set to true to delete messages upon failure.

Class ClientConfiguration

Field Summary

Fields inherited from interface com.amazonaws.services.cloudtrail.processinglibrary.configuration.ProcessingConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

awsCredentialsProvider

sqsUrl

sqsRegion

visibilityTimeout

s3Region

threadCount

numOfParallelReaders

threadTerminationDelaySeconds

maxEventsPerEmit

enableRawEventInfo

deleteMessageUponFailure

Constructor Detail

ClientConfiguration

Method Detail

getAwsCredentialsProvider

getSqsUrl

getSqsRegion

getVisibilityTimeout

getS3Region

getThreadCount

getNumOfParallelReaders

getThreadTerminationDelaySeconds

getMaxEventsPerEmit

isEnableRawEventInfo

isDeleteMessageUponFailure

validate

setAwsCredentialsProvider

setSqsRegion

setVisibilityTimeout

setS3Region

setThreadCount

setNumOfParallelReaders

setThreadTerminationDelaySeconds

setMaxEventsPerEmit

setEnableRawEventInfo

setDeleteMessageUponFailure