com.amazonaws.services.cloudtrail.processinglibrary.configuration

Class PropertiesFileConfiguration

java.lang.Object

com.amazonaws.services.cloudtrail.processinglibrary.configuration.PropertiesFileConfiguration

All Implemented Interfaces:

ProcessingConfiguration

public class PropertiesFileConfiguration
extends java.lang.Object
implements ProcessingConfiguration

A class used to obtain AWS CloudTrail Processing Library configuration information from a classpath properties file.

In addition to this class, you can use ClientConfiguration to manually set configuration options.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_KEY
static java.lang.String	DELETE_MESSAGE_UPON_FAILURE
static java.lang.String	ENABLE_RAW_EVENT_INFO
static java.lang.String	MAX_EVENTS_PER_EMIT
static java.lang.String	NUM_OF_PARALLEL_READERS
static java.lang.String	S3_REGION
static java.lang.String	SECRET_KEY
static java.lang.String	SQS_REGION
static java.lang.String	SQS_URL
static java.lang.String	THREAD_COUNT
static java.lang.String	THREAD_TERMINATION_DELAY_SECONDS
static java.lang.String	VISIBILITY_TIMEOUT

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
PropertiesFileConfiguration(java.lang.String propertiesFile) Creates a PropertiesFileConfiguration from values provided in a classpath properties file.

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ACCESS_KEY

public static final java.lang.String ACCESS_KEY

See Also:

Constant Field Values

SECRET_KEY

public static final java.lang.String SECRET_KEY

See Also:

Constant Field Values

SQS_URL

public static final java.lang.String SQS_URL

See Also:

Constant Field Values

SQS_REGION

public static final java.lang.String SQS_REGION

See Also:

Constant Field Values

VISIBILITY_TIMEOUT

public static final java.lang.String VISIBILITY_TIMEOUT

See Also:

Constant Field Values

S3_REGION

public static final java.lang.String S3_REGION

See Also:

Constant Field Values

THREAD_COUNT

public static final java.lang.String THREAD_COUNT

See Also:

Constant Field Values

NUM_OF_PARALLEL_READERS

public static final java.lang.String NUM_OF_PARALLEL_READERS

See Also:

Constant Field Values

THREAD_TERMINATION_DELAY_SECONDS

public static final java.lang.String THREAD_TERMINATION_DELAY_SECONDS

See Also:

Constant Field Values

MAX_EVENTS_PER_EMIT

public static final java.lang.String MAX_EVENTS_PER_EMIT

See Also:

Constant Field Values

ENABLE_RAW_EVENT_INFO

public static final java.lang.String ENABLE_RAW_EVENT_INFO

See Also:

Constant Field Values

DELETE_MESSAGE_UPON_FAILURE

public static final java.lang.String DELETE_MESSAGE_UPON_FAILURE

See Also:

Constant Field Values

Constructor Detail

PropertiesFileConfiguration

public PropertiesFileConfiguration(java.lang.String propertiesFile)

Creates a PropertiesFileConfiguration from values provided in a classpath properties file.

Parameters:

propertiesFile - the classpath properties file to load.

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