camel-aws-s3-kafka-connector sink configuration

When using camel-aws-s3-kafka-connector as sink 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 Sink connector in Kafka connect you’ll need to set the following connector.class

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

The camel-aws-s3 sink connector supports 65 options, which are listed below.

Name	Description	Default	Required	Priority
camel.sink.path.bucketNameOrArn	Bucket name or ARN	null	true	HIGH
camel.sink.endpoint.amazonS3Client	Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.	null	false	MEDIUM
camel.sink.endpoint.autoCreateBucket	Setting the autocreation of the bucket	true	false	MEDIUM
camel.sink.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	false	MEDIUM
camel.sink.endpoint.endpointConfiguration	Amazon AWS Endpoint Configuration	null	false	MEDIUM
camel.sink.endpoint.pathStyleAccess	Whether or not the S3 client should use path style access	false	false	MEDIUM
camel.sink.endpoint.policy	The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.	null	false	MEDIUM
camel.sink.endpoint.proxyHost	To define a proxy host when instantiating the S3 client	null	false	MEDIUM
camel.sink.endpoint.proxyPort	Specify a proxy port to be used inside the client definition.	null	false	MEDIUM
camel.sink.endpoint.proxyProtocol	To define a proxy protocol when instantiating the S3 client One of: [HTTP] [HTTPS]	"HTTPS"	false	MEDIUM
camel.sink.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	false	MEDIUM
camel.sink.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	false	MEDIUM
camel.sink.endpoint.encryptionMaterials	The encryption materials to use in case of Symmetric/Asymmetric client usage	null	false	MEDIUM
camel.sink.endpoint.useEncryption	Define if encryption must be used or not	false	false	MEDIUM
camel.sink.endpoint.deleteAfterWrite	Delete file object after the S3 file has been uploaded	false	false	MEDIUM
camel.sink.endpoint.keyName	Setting the key name for an element in the bucket through endpoint parameter	null	false	MEDIUM
camel.sink.endpoint.lazyStartProducer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	false	MEDIUM
camel.sink.endpoint.multiPartUpload	If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize	false	false	MEDIUM
camel.sink.endpoint.operation	The operation to do in case the user don’t want to do only an upload One of: [copyObject] [deleteBucket] [listBuckets] [downloadLink]	null	false	MEDIUM
camel.sink.endpoint.partSize	Setup the partSize which is used in multi part upload, the default size is 25M.	26214400L	false	MEDIUM
camel.sink.endpoint.serverSideEncryption	Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256.	null	false	MEDIUM
camel.sink.endpoint.storageClass	The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.	null	false	MEDIUM
camel.sink.endpoint.awsKMSKeyId	Define the id of KMS key to use in case KMS is enabled	null	false	MEDIUM
camel.sink.endpoint.useAwsKMS	Define if KMS must be used or not	false	false	MEDIUM
camel.sink.endpoint.accelerateModeEnabled	Define if Accelerate Mode enabled is true or false	false	false	MEDIUM
camel.sink.endpoint.chunkedEncodingDisabled	Define if disabled Chunked Encoding is true or false	false	false	MEDIUM
camel.sink.endpoint.dualstackEnabled	Define if Dualstack enabled is true or false	false	false	MEDIUM
camel.sink.endpoint.forceGlobalBucketAccessEnabled	Define if Force Global Bucket Access enabled is true or false	false	false	MEDIUM
camel.sink.endpoint.payloadSigningEnabled	Define if Payload Signing enabled is true or false	false	false	MEDIUM
camel.sink.endpoint.basicPropertyBinding	Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	MEDIUM
camel.sink.endpoint.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	false	MEDIUM
camel.sink.endpoint.accessKey	Amazon AWS Access Key	null	false	MEDIUM
camel.sink.endpoint.secretKey	Amazon AWS Secret Key	null	false	MEDIUM
camel.component.aws-s3.amazonS3Client	Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.	null	false	MEDIUM
camel.component.aws-s3.autoCreateBucket	Setting the autocreation of the bucket	true	false	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	false	MEDIUM
camel.component.aws-s3.configuration	The component configuration	null	false	MEDIUM
camel.component.aws-s3.endpointConfiguration	Amazon AWS Endpoint Configuration	null	false	MEDIUM
camel.component.aws-s3.pathStyleAccess	Whether or not the S3 client should use path style access	false	false	MEDIUM
camel.component.aws-s3.policy	The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.	null	false	MEDIUM
camel.component.aws-s3.proxyHost	To define a proxy host when instantiating the S3 client	null	false	MEDIUM
camel.component.aws-s3.proxyPort	Specify a proxy port to be used inside the client definition.	null	false	MEDIUM
camel.component.aws-s3.proxyProtocol	To define a proxy protocol when instantiating the S3 client One of: [HTTP] [HTTPS]	"HTTPS"	false	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	false	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	false	MEDIUM
camel.component.aws-s3.encryptionMaterials	The encryption materials to use in case of Symmetric/Asymmetric client usage	null	false	MEDIUM
camel.component.aws-s3.useEncryption	Define if encryption must be used or not	false	false	MEDIUM
camel.component.aws-s3.deleteAfterWrite	Delete file object after the S3 file has been uploaded	false	false	MEDIUM
camel.component.aws-s3.keyName	Setting the key name for an element in the bucket through endpoint parameter	null	false	MEDIUM
camel.component.aws-s3.lazyStartProducer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	false	MEDIUM
camel.component.aws-s3.multiPartUpload	If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize	false	false	MEDIUM
camel.component.aws-s3.operation	The operation to do in case the user don’t want to do only an upload One of: [copyObject] [deleteBucket] [listBuckets] [downloadLink]	null	false	MEDIUM
camel.component.aws-s3.partSize	Setup the partSize which is used in multi part upload, the default size is 25M.	26214400L	false	MEDIUM
camel.component.aws-s3.serverSideEncryption	Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256.	null	false	MEDIUM
camel.component.aws-s3.storageClass	The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.	null	false	MEDIUM
camel.component.aws-s3.awsKMSKeyId	Define the id of KMS key to use in case KMS is enabled	null	false	MEDIUM
camel.component.aws-s3.useAwsKMS	Define if KMS must be used or not	false	false	MEDIUM
camel.component.aws-s3.accelerateModeEnabled	Define if Accelerate Mode enabled is true or false	false	false	MEDIUM
camel.component.aws-s3.chunkedEncodingDisabled	Define if disabled Chunked Encoding is true or false	false	false	MEDIUM
camel.component.aws-s3.dualstackEnabled	Define if Dualstack enabled is true or false	false	false	MEDIUM
camel.component.aws-s3.forceGlobalBucketAccess Enabled	Define if Force Global Bucket Access enabled is true or false	false	false	MEDIUM
camel.component.aws-s3.payloadSigningEnabled	Define if Payload Signing enabled is true or false	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	false	LOW
camel.component.aws-s3.accessKey	Amazon AWS Access Key	null	false	MEDIUM
camel.component.aws-s3.secretKey	Amazon AWS Secret Key	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.sink.path.bucketNameOrArn

Bucket name or ARN

null

true

HIGH

camel.sink.endpoint.amazonS3Client

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

null

false

MEDIUM

camel.sink.endpoint.autoCreateBucket

Setting the autocreation of the bucket

true

false

MEDIUM

camel.sink.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

false

MEDIUM

camel.sink.endpoint.endpointConfiguration

Amazon AWS Endpoint Configuration

null

false

MEDIUM

camel.sink.endpoint.pathStyleAccess

Whether or not the S3 client should use path style access

false

MEDIUM

camel.sink.endpoint.policy

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

null

false

MEDIUM

camel.sink.endpoint.proxyHost

To define a proxy host when instantiating the S3 client

null

false

MEDIUM

camel.sink.endpoint.proxyPort

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

null

false

MEDIUM

camel.sink.endpoint.proxyProtocol

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

"HTTPS"

false

MEDIUM

camel.sink.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

false

MEDIUM

camel.sink.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.sink.endpoint.encryptionMaterials

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

null

false

MEDIUM

camel.sink.endpoint.useEncryption

Define if encryption must be used or not

false

MEDIUM

camel.sink.endpoint.deleteAfterWrite

Delete file object after the S3 file has been uploaded

false

MEDIUM

camel.sink.endpoint.keyName

Setting the key name for an element in the bucket through endpoint parameter

null

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.multiPartUpload

If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize

false

MEDIUM

camel.sink.endpoint.operation

The operation to do in case the user don’t want to do only an upload One of: [copyObject] [deleteBucket] [listBuckets] [downloadLink]

null

false

MEDIUM

camel.sink.endpoint.partSize

Setup the partSize which is used in multi part upload, the default size is 25M.

26214400L

false

MEDIUM

camel.sink.endpoint.serverSideEncryption

Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256.

null

false

MEDIUM

camel.sink.endpoint.storageClass

The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.

null

false

MEDIUM

camel.sink.endpoint.awsKMSKeyId

Define the id of KMS key to use in case KMS is enabled

null

false

MEDIUM

camel.sink.endpoint.useAwsKMS

Define if KMS must be used or not

false

MEDIUM

camel.sink.endpoint.accelerateModeEnabled

Define if Accelerate Mode enabled is true or false

false

MEDIUM

camel.sink.endpoint.chunkedEncodingDisabled

Define if disabled Chunked Encoding is true or false

false

MEDIUM

camel.sink.endpoint.dualstackEnabled

Define if Dualstack enabled is true or false

false

MEDIUM

camel.sink.endpoint.forceGlobalBucketAccessEnabled

Define if Force Global Bucket Access enabled is true or false

false

MEDIUM

camel.sink.endpoint.payloadSigningEnabled

Define if Payload Signing enabled is true or false

false

MEDIUM

camel.sink.endpoint.basicPropertyBinding

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

false

MEDIUM

camel.sink.endpoint.synchronous

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

false

MEDIUM

camel.sink.endpoint.accessKey

Amazon AWS Access Key

null

false

MEDIUM

camel.sink.endpoint.secretKey

Amazon AWS Secret Key

null

false

MEDIUM

camel.component.aws-s3.amazonS3Client

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

null

false

MEDIUM

camel.component.aws-s3.autoCreateBucket

Setting the autocreation of the bucket

true

false

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

false

MEDIUM

camel.component.aws-s3.configuration

The component configuration

null

false

MEDIUM

camel.component.aws-s3.endpointConfiguration

Amazon AWS Endpoint Configuration

null

false

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

false

MEDIUM

camel.component.aws-s3.proxyHost

To define a proxy host when instantiating the S3 client

null

false

MEDIUM

camel.component.aws-s3.proxyPort

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

null

false

MEDIUM

camel.component.aws-s3.proxyProtocol

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

"HTTPS"

false

MEDIUM

camel.component.aws-s3.region

null

false

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

false

MEDIUM

camel.component.aws-s3.useEncryption

Define if encryption must be used or not

false

MEDIUM

camel.component.aws-s3.deleteAfterWrite

Delete file object after the S3 file has been uploaded

false

MEDIUM

camel.component.aws-s3.keyName

Setting the key name for an element in the bucket through endpoint parameter

null

false

MEDIUM

camel.component.aws-s3.lazyStartProducer

false

MEDIUM

camel.component.aws-s3.multiPartUpload

If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize

false

MEDIUM

camel.component.aws-s3.operation

The operation to do in case the user don’t want to do only an upload One of: [copyObject] [deleteBucket] [listBuckets] [downloadLink]

null

false

MEDIUM

camel.component.aws-s3.partSize

Setup the partSize which is used in multi part upload, the default size is 25M.

26214400L

false

MEDIUM

camel.component.aws-s3.serverSideEncryption

Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256.

null

false

MEDIUM

camel.component.aws-s3.storageClass

The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.

null

false

MEDIUM

camel.component.aws-s3.awsKMSKeyId

Define the id of KMS key to use in case KMS is enabled

null

false

MEDIUM

camel.component.aws-s3.useAwsKMS

Define if KMS must be used or not

false

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

LOW

camel.component.aws-s3.accessKey

Amazon AWS Access Key

null

false

MEDIUM

camel.component.aws-s3.secretKey

Amazon AWS Secret Key

null

false

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 supports 1 transforms out of the box, which are listed below.

org.apache.camel.kafkaconnector.awss3.transformers.S3ObjectTransforms

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