2 Home
gitea_admin edited this page 2026-03-11 14:35:16 +00:00

AWS Cloudtrail

Consume events from Amazon Cloudtrail using AWS SDK version 2.x.

Metadata

Property Value
Scheme aws-cloudtrail
Support Level Stable
Labels cloud,management,monitoring
Version 4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-aws-cloudtrail</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name Type Required Default Description
label string A label for indexing cloudtrail endpoints
eventSource string Specify an event source to select events
maxResults integer 1 Maximum number of records that will be fetched in each poll
overrideEndpoint boolean false Set the need for overriding the endpoint. This option needs to be used in combination with uriEndpointOverride option
region string The region in which Cloudtrail client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()
sendEmptyMessageWhenIdle boolean false If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
uriEndpointOverride string Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option
bridgeErrorHandler boolean false Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.
exceptionHandler object To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
exchangePattern object Sets the exchange pattern when the consumer creates an exchange.
pollStrategy object A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
cloudTrailClient object Amazon Cloudtrail client to use for all requests for this endpoint
proxyHost string To define a proxy host when instantiating the Cloudtrail client
proxyPort integer To define a proxy port when instantiating the Cloudtrail client
proxyProtocol object HTTPS To define a proxy protocol when instantiating the Cloudtrail client
backoffErrorThreshold integer The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
backoffIdleThreshold integer The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
backoffMultiplier integer To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
delay integer 500 Milliseconds before the next poll.
greedy boolean false If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
initialDelay integer 1000 Milliseconds before the first poll starts.
repeatCount integer 0 Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever.
runLoggingLevel object TRACE The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
scheduledExecutorService object Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
scheduler object none To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
schedulerProperties object To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
startScheduler boolean true Whether the scheduler should be auto started.
timeUnit object MILLISECONDS Time unit for initialDelay and delay options.
useFixedDelay boolean true Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
accessKey string Amazon AWS Access Key
profileCredentialsName string If using a profile credentials provider this parameter will set the profile name.
secretKey string Amazon AWS Secret Key
sessionToken string Amazon AWS Session Token used when the user needs to assume a IAM role
trustAllCertificates boolean false If we want to trust all certificates in case of overriding the endpoint
useDefaultCredentialsProvider boolean false Set whether the Cloudtrail client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.
useProfileCredentialsProvider boolean false Set whether the Cloudtrail client should expect to load credentials through a profile credentials provider.
useSessionCredentials boolean false Set whether the CloudTrail client should expect to use Session Credentials. This is useful in situation in which the user needs to assume a IAM role for doing operations in CloudTrail.