camel-aws-s3-kafka-connector source configuration

When using camel-aws-s3-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-aws-s3-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.awss3.CamelAwss3SourceConnector

The camel-aws-s3 source connector supports 79 options, which are listed below.

Name Description Default Priority

camel.source.path.bucketNameOrArn

Bucket name or ARN

null

HIGH

camel.source.endpoint.amazonS3Client

Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.

null

MEDIUM

camel.source.endpoint.autoCreateBucket

Setting the autocreation of the bucket

true

MEDIUM

camel.source.endpoint.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.source.endpoint.endpointConfiguration

Amazon AWS Endpoint Configuration

null

MEDIUM

camel.source.endpoint.pathStyleAccess

Whether or not the S3 client should use path style access

false

MEDIUM

camel.source.endpoint.policy

The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.

null

MEDIUM

camel.source.endpoint.proxyHost

To define a proxy host when instantiating the S3 client

null

MEDIUM

camel.source.endpoint.proxyPort

Specify a proxy port to be used inside the client definition.

null

MEDIUM

camel.source.endpoint.proxyProtocol

To define a proxy protocol when instantiating the S3 client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.source.endpoint.region

The region in which S3 client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You’ll need to use the name Regions.EU_WEST_1.name()

null

MEDIUM

camel.source.endpoint.useIAMCredentials

Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in.

false

MEDIUM

camel.source.endpoint.encryptionMaterials

The encryption materials to use in case of Symmetric/Asymmetric client usage

null

MEDIUM

camel.source.endpoint.useEncryption

Define if encryption must be used or not

false

MEDIUM

camel.source.endpoint.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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.

false

MEDIUM

camel.source.endpoint.deleteAfterRead

Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the S3Constants#BUCKET_NAME and S3Constants#KEY headers, or only the S3Constants#KEY header.

true

MEDIUM

camel.source.endpoint.delimiter

The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.

null

MEDIUM

camel.source.endpoint.fileName

To get the object from the bucket with the given file name

null

MEDIUM

camel.source.endpoint.includeBody

If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the S3 object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically.

true

MEDIUM

camel.source.endpoint.maxConnections

Set the maxConnections parameter in the S3 client configuration

60

MEDIUM

camel.source.endpoint.maxMessagesPerPoll

Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited.

10

MEDIUM

camel.source.endpoint.prefix

The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.

null

MEDIUM

camel.source.endpoint.sendEmptyMessageWhenIdle

If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.

false

MEDIUM

camel.source.endpoint.autocloseBody

If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically.

true

MEDIUM

camel.source.endpoint.exceptionHandler

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.

null

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

MEDIUM

camel.source.endpoint.pollStrategy

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.

null

MEDIUM

camel.source.endpoint.accelerateModeEnabled

Define if Accelerate Mode enabled is true or false

false

MEDIUM

camel.source.endpoint.chunkedEncodingDisabled

Define if disabled Chunked Encoding is true or false

false

MEDIUM

camel.source.endpoint.dualstackEnabled

Define if Dualstack enabled is true or false

false

MEDIUM

camel.source.endpoint.forceGlobalBucketAccess Enabled

Define if Force Global Bucket Access enabled is true or false

false

MEDIUM

camel.source.endpoint.payloadSigningEnabled

Define if Payload Signing enabled is true or false

false

MEDIUM

camel.source.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.source.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.source.endpoint.backoffErrorThreshold

The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffIdleThreshold

The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.

null

MEDIUM

camel.source.endpoint.backoffMultiplier

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.

null

MEDIUM

camel.source.endpoint.delay

Milliseconds before the next poll.

500L

MEDIUM

camel.source.endpoint.greedy

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

false

MEDIUM

camel.source.endpoint.initialDelay

Milliseconds before the first poll starts.

1000L

MEDIUM

camel.source.endpoint.repeatCount

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.

0L

MEDIUM

camel.source.endpoint.runLoggingLevel

The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF]

"TRACE"

MEDIUM

camel.source.endpoint.scheduledExecutorService

Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.

null

MEDIUM

camel.source.endpoint.scheduler

To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler

"none"

MEDIUM

camel.source.endpoint.schedulerProperties

To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.

null

MEDIUM

camel.source.endpoint.startScheduler

Whether the scheduler should be auto started.

true

MEDIUM

camel.source.endpoint.timeUnit

Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS]

"MILLISECONDS"

MEDIUM

camel.source.endpoint.useFixedDelay

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

true

MEDIUM

camel.source.endpoint.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.source.endpoint.secretKey

Amazon AWS Secret Key

null

MEDIUM

camel.component.aws-s3.amazonS3Client

Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.

null

MEDIUM

camel.component.aws-s3.autoCreateBucket

Setting the autocreation of the bucket

true

MEDIUM

camel.component.aws-s3.autoDiscoverClient

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

MEDIUM

camel.component.aws-s3.configuration

The component configuration

null

MEDIUM

camel.component.aws-s3.endpointConfiguration

Amazon AWS Endpoint Configuration

null

MEDIUM

camel.component.aws-s3.pathStyleAccess

Whether or not the S3 client should use path style access

false

MEDIUM

camel.component.aws-s3.policy

The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.

null

MEDIUM

camel.component.aws-s3.proxyHost

To define a proxy host when instantiating the S3 client

null

MEDIUM

camel.component.aws-s3.proxyPort

Specify a proxy port to be used inside the client definition.

null

MEDIUM

camel.component.aws-s3.proxyProtocol

To define a proxy protocol when instantiating the S3 client One of: [HTTP] [HTTPS]

"HTTPS"

MEDIUM

camel.component.aws-s3.region

The region in which S3 client needs to work. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You’ll need to use the name Regions.EU_WEST_1.name()

null

MEDIUM

camel.component.aws-s3.useIAMCredentials

Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in.

false

MEDIUM

camel.component.aws-s3.encryptionMaterials

The encryption materials to use in case of Symmetric/Asymmetric client usage

null

MEDIUM

camel.component.aws-s3.useEncryption

Define if encryption must be used or not

false

MEDIUM

camel.component.aws-s3.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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.

false

MEDIUM

camel.component.aws-s3.deleteAfterRead

Delete objects from S3 after they have been retrieved. The delete is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the S3Constants#BUCKET_NAME and S3Constants#KEY headers, or only the S3Constants#KEY header.

true

MEDIUM

camel.component.aws-s3.delimiter

The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.

null

MEDIUM

camel.component.aws-s3.fileName

To get the object from the bucket with the given file name

null

MEDIUM

camel.component.aws-s3.includeBody

If it is true, the exchange body will be set to a stream to the contents of the file. If false, the headers will be set with the S3 object metadata, but the body will be null. This option is strongly related to autocloseBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically.

true

MEDIUM

camel.component.aws-s3.prefix

The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.

null

MEDIUM

camel.component.aws-s3.autocloseBody

If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically.

true

MEDIUM

camel.component.aws-s3.accelerateModeEnabled

Define if Accelerate Mode enabled is true or false

false

MEDIUM

camel.component.aws-s3.chunkedEncodingDisabled

Define if disabled Chunked Encoding is true or false

false

MEDIUM

camel.component.aws-s3.dualstackEnabled

Define if Dualstack enabled is true or false

false

MEDIUM

camel.component.aws-s3.forceGlobalBucketAccess Enabled

Define if Force Global Bucket Access enabled is true or false

false

MEDIUM

camel.component.aws-s3.payloadSigningEnabled

Define if Payload Signing enabled is true or false

false

MEDIUM

camel.component.aws-s3.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.aws-s3.accessKey

Amazon AWS Access Key

null

MEDIUM

camel.component.aws-s3.secretKey

Amazon AWS Secret Key

null

MEDIUM

The camel-aws-s3 sink connector supports 1 converters out of the box, which are listed below.

org.apache.camel.kafkaconnector.awss3.converters.S3ObjectConverter

The camel-aws-s3 sink connector has no transforms out of the box.

The camel-aws-s3 sink connector has no aggregation strategies out of the box.

Examples

Here is an example of configuration of the source connector

name=CamelAWSS3SourceConnector
connector.class=org.apache.camel.kafkaconnector.awss3.CamelAwss3SourceConnector
key.converter=org.apache.kafka.connect.storage.StringConverter
value.converter=org.apache.camel.kafkaconnector.awss3.converters.S3ObjectConverter

camel.source.maxPollDuration=10000

topics=mytopic

camel.source.url=aws-s3://camel-kafka-connector?autocloseBody=false

camel.component.aws-s3.access-key=xxxx
camel.component.aws-s3.secret-key=yyyy
camel.component.aws-s3.region=EU_WEST_1

In this example we are polling the bucket camel-kafka-connector as source.