camel-aws-s3-source-kafka-connector source configuration

Connector Description: Receive data from an Amazon S3 Bucket. The basic authentication method for the S3 service is to specify an access key and a secret key. These parameters are optional because the Kamelet provides a default credentials provider. If you use the default credentials provider, the S3 client loads the credentials through this provider and doesn’t use the basic authentication method. Two headers will be duplicated with different names for clarity at sink level, CamelAwsS3Key will be duplicated into aws.s3.key and CamelAwsS3BucketName will be duplicated in aws.s3.bucket.name

When using camel-aws-s3-source-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-source-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.awss3source.CamelAwss3sourceSourceConnector

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

Name Description Default Priority

camel.kamelet.aws-s3-source.bucketNameOrArn

Required The S3 Bucket name or Amazon Resource Name (ARN).

HIGH

camel.kamelet.aws-s3-source.deleteAfterRead

Specifies to delete objects after consuming them.

true

MEDIUM

camel.kamelet.aws-s3-source.accessKey

The access key obtained from AWS.

MEDIUM

camel.kamelet.aws-s3-source.secretKey

The secret key obtained from AWS.

MEDIUM

camel.kamelet.aws-s3-source.region

Required The AWS region to access.

HIGH

camel.kamelet.aws-s3-source.autoCreateBucket

Specifies to automatically create the S3 bucket.

false

MEDIUM

camel.kamelet.aws-s3-source.includeBody

If true, the exchange is consumed and put into the body and closed. If false, the S3Object stream is put raw into the body and the headers are set with the S3 object metadata.

true

MEDIUM

camel.kamelet.aws-s3-source.prefix

The AWS S3 bucket prefix to consider while searching. Example: folder/.

MEDIUM

camel.kamelet.aws-s3-source.ignoreBody

If true, the S3 Object body is ignored. Setting this to true overrides any behavior defined by the includeBody option. If false, the S3 object is put in the body.

false

MEDIUM

camel.kamelet.aws-s3-source.useDefaultCredentialsProvider

If true, the S3 client loads credentials through a default credentials provider. If false, it uses the basic authentication method (access key and secret key).

false

MEDIUM

camel.kamelet.aws-s3-source.uriEndpointOverride

The overriding endpoint URI. To use this option, you must also select the overrideEndpoint option.

MEDIUM

camel.kamelet.aws-s3-source.overrideEndpoint

Select this option to override the endpoint URI. To use this option, you must also provide a URI for the uriEndpointOverride option.

false

MEDIUM

camel.kamelet.aws-s3-source.delay

The number of milliseconds before the next poll of the selected bucket.

500

MEDIUM

The camel-aws-s3-source source connector has no converters out of the box.

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

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

Back to top