camel-aws-sqs-kafka-connector sink configuration

When using camel-aws-sqs-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-sqs-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.awssqs.CamelAwssqsSinkConnector

The camel-aws-sqs sink connector supports 54 options, which are listed below.

Name	Description	Default	Required	Priority
camel.sink.path.queueNameOrArn	Queue name or ARN	null	true	HIGH
camel.sink.endpoint.amazonAWSHost	The hostname of the Amazon AWS cloud.	"amazonaws.com"	false	MEDIUM
camel.sink.endpoint.amazonSQSClient	To use the AmazonSQS as client	null	false	MEDIUM
camel.sink.endpoint.autoCreateQueue	Setting the autocreation of the queue	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.headerFilterStrategy	To use a custom HeaderFilterStrategy to map headers to/from Camel.	null	false	MEDIUM
camel.sink.endpoint.protocol	The underlying protocol used to communicate with SQS	"https"	false	MEDIUM
camel.sink.endpoint.proxyProtocol	To define a proxy protocol when instantiating the SQS client One of: [HTTP] [HTTPS]	"HTTPS"	false	MEDIUM
camel.sink.endpoint.queueOwnerAWSAccountId	Specify the queue owner aws account id when you need to connect the queue with different account owner.	null	false	MEDIUM
camel.sink.endpoint.region	Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. 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.delaySeconds	Delay sending messages for a number of seconds.	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.messageDeduplicationIdStrategy	Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. One of: [useExchangeId] [useContentBasedDeduplication]	"useExchangeId"	false	MEDIUM
camel.sink.endpoint.messageGroupIdStrategy	Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. One of: [useConstant] [useExchangeId] [usePropertyValue]	null	false	MEDIUM
camel.sink.endpoint.operation	The operation to do in case the user don’t want to send only a message One of: [sendBatchMessage] [deleteMessage] [listQueues]	null	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.delayQueue	Define if you want to apply delaySeconds option to the queue or on single messages	false	false	MEDIUM
camel.sink.endpoint.queueUrl	To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes.	null	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.proxyHost	To define a proxy host when instantiating the SQS client	null	false	MEDIUM
camel.sink.endpoint.proxyPort	To define a proxy port when instantiating the SQS client	null	false	MEDIUM
camel.sink.endpoint.maximumMessageSize	The maximumMessageSize (in bytes) an SQS message can contain for this queue.	null	false	MEDIUM
camel.sink.endpoint.messageRetentionPeriod	The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.	null	false	MEDIUM
camel.sink.endpoint.policy	The policy for this queue	null	false	MEDIUM
camel.sink.endpoint.receiveMessageWaitTimeSeconds	If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.	null	false	MEDIUM
camel.sink.endpoint.redrivePolicy	Specify the policy that send message to DeadLetter queue. See detail at Amazon docs.	null	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-sqs.amazonAWSHost	The hostname of the Amazon AWS cloud.	"amazonaws.com"	false	MEDIUM
camel.component.aws-sqs.amazonSQSClient	To use the AmazonSQS as client	null	false	MEDIUM
camel.component.aws-sqs.autoCreateQueue	Setting the autocreation of the queue	true	false	MEDIUM
camel.component.aws-sqs.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-sqs.configuration	The component configuration	null	false	MEDIUM
camel.component.aws-sqs.protocol	The underlying protocol used to communicate with SQS	"https"	false	MEDIUM
camel.component.aws-sqs.proxyProtocol	To define a proxy protocol when instantiating the SQS client One of: [HTTP] [HTTPS]	"HTTPS"	false	MEDIUM
camel.component.aws-sqs.queueOwnerAWSAccountId	Specify the queue owner aws account id when you need to connect the queue with different account owner.	null	false	MEDIUM
camel.component.aws-sqs.region	Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. 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-sqs.delaySeconds	Delay sending messages for a number of seconds.	null	false	MEDIUM
camel.component.aws-sqs.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-sqs.messageDeduplicationId Strategy	Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. One of: [useExchangeId] [useContentBasedDeduplication]	"useExchangeId"	false	MEDIUM
camel.component.aws-sqs.messageGroupIdStrategy	Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. One of: [useConstant] [useExchangeId] [usePropertyValue]	null	false	MEDIUM
camel.component.aws-sqs.operation	The operation to do in case the user don’t want to send only a message One of: [sendBatchMessage] [deleteMessage] [listQueues]	null	false	MEDIUM
camel.component.aws-sqs.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-sqs.delayQueue	Define if you want to apply delaySeconds option to the queue or on single messages	false	false	MEDIUM
camel.component.aws-sqs.queueUrl	To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes.	null	false	MEDIUM
camel.component.aws-sqs.proxyHost	To define a proxy host when instantiating the SQS client	null	false	MEDIUM
camel.component.aws-sqs.proxyPort	To define a proxy port when instantiating the SQS client	null	false	MEDIUM
camel.component.aws-sqs.maximumMessageSize	The maximumMessageSize (in bytes) an SQS message can contain for this queue.	null	false	MEDIUM
camel.component.aws-sqs.messageRetentionPeriod	The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.	null	false	MEDIUM
camel.component.aws-sqs.policy	The policy for this queue	null	false	MEDIUM
camel.component.aws-sqs.receiveMessageWaitTime Seconds	If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.	null	false	MEDIUM
camel.component.aws-sqs.redrivePolicy	Specify the policy that send message to DeadLetter queue. See detail at Amazon docs.	null	false	MEDIUM
camel.component.aws-sqs.accessKey	Amazon AWS Access Key	null	false	MEDIUM
camel.component.aws-sqs.secretKey	Amazon AWS Secret Key	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.sink.path.queueNameOrArn

Queue name or ARN

null

true

HIGH

camel.sink.endpoint.amazonAWSHost

The hostname of the Amazon AWS cloud.

"amazonaws.com"

false

MEDIUM

camel.sink.endpoint.amazonSQSClient

To use the AmazonSQS as client

null

false

MEDIUM

camel.sink.endpoint.autoCreateQueue

Setting the autocreation of the queue

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.headerFilterStrategy

To use a custom HeaderFilterStrategy to map headers to/from Camel.

null

false

MEDIUM

camel.sink.endpoint.protocol

The underlying protocol used to communicate with SQS

"https"

false

MEDIUM

camel.sink.endpoint.proxyProtocol

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

"HTTPS"

false

MEDIUM

camel.sink.endpoint.queueOwnerAWSAccountId

Specify the queue owner aws account id when you need to connect the queue with different account owner.

null

false

MEDIUM

camel.sink.endpoint.region

Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. 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.delaySeconds

Delay sending messages for a number of seconds.

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.messageDeduplicationIdStrategy

Only for FIFO queues. Strategy for setting the messageDeduplicationId on the message. Can be one of the following options: useExchangeId, useContentBasedDeduplication. For the useContentBasedDeduplication option, no messageDeduplicationId will be set on the message. One of: [useExchangeId] [useContentBasedDeduplication]

"useExchangeId"

false

MEDIUM

camel.sink.endpoint.messageGroupIdStrategy

Only for FIFO queues. Strategy for setting the messageGroupId on the message. Can be one of the following options: useConstant, useExchangeId, usePropertyValue. For the usePropertyValue option, the value of property CamelAwsMessageGroupId will be used. One of: [useConstant] [useExchangeId] [usePropertyValue]

null

false

MEDIUM

camel.sink.endpoint.operation

The operation to do in case the user don’t want to send only a message One of: [sendBatchMessage] [deleteMessage] [listQueues]

null

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.delayQueue

Define if you want to apply delaySeconds option to the queue or on single messages

false

MEDIUM

camel.sink.endpoint.queueUrl

To define the queueUrl explicitly. All other parameters, which would influence the queueUrl, are ignored. This parameter is intended to be used, to connect to a mock implementation of SQS, for testing purposes.

null

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.proxyHost

To define a proxy host when instantiating the SQS client

null

false

MEDIUM

camel.sink.endpoint.proxyPort

To define a proxy port when instantiating the SQS client

null

false

MEDIUM

camel.sink.endpoint.maximumMessageSize

The maximumMessageSize (in bytes) an SQS message can contain for this queue.

null

false

MEDIUM

camel.sink.endpoint.messageRetentionPeriod

The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.

null

false

MEDIUM

camel.sink.endpoint.policy

The policy for this queue

null

false

MEDIUM

camel.sink.endpoint.receiveMessageWaitTimeSeconds

If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.

null

false

MEDIUM

camel.sink.endpoint.redrivePolicy

Specify the policy that send message to DeadLetter queue. See detail at Amazon docs.

null

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-sqs.amazonAWSHost

The hostname of the Amazon AWS cloud.

"amazonaws.com"

false

MEDIUM

camel.component.aws-sqs.amazonSQSClient

To use the AmazonSQS as client

null

false

MEDIUM

camel.component.aws-sqs.autoCreateQueue

Setting the autocreation of the queue

true

false

MEDIUM

camel.component.aws-sqs.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-sqs.configuration

The component configuration

null

false

MEDIUM

camel.component.aws-sqs.protocol

The underlying protocol used to communicate with SQS

"https"

false

MEDIUM

camel.component.aws-sqs.proxyProtocol

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

"HTTPS"

false

MEDIUM

camel.component.aws-sqs.queueOwnerAWSAccountId

Specify the queue owner aws account id when you need to connect the queue with different account owner.

null

false

MEDIUM

camel.component.aws-sqs.region

null

false

MEDIUM

camel.component.aws-sqs.delaySeconds

Delay sending messages for a number of seconds.

null

false

MEDIUM

camel.component.aws-sqs.lazyStartProducer

false

MEDIUM

camel.component.aws-sqs.messageDeduplicationId Strategy

"useExchangeId"

false

MEDIUM

camel.component.aws-sqs.messageGroupIdStrategy

null

false

MEDIUM

camel.component.aws-sqs.operation

The operation to do in case the user don’t want to send only a message One of: [sendBatchMessage] [deleteMessage] [listQueues]

null

false

MEDIUM

camel.component.aws-sqs.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-sqs.delayQueue

Define if you want to apply delaySeconds option to the queue or on single messages

false

MEDIUM

camel.component.aws-sqs.queueUrl

null

false

MEDIUM

camel.component.aws-sqs.proxyHost

To define a proxy host when instantiating the SQS client

null

false

MEDIUM

camel.component.aws-sqs.proxyPort

To define a proxy port when instantiating the SQS client

null

false

MEDIUM

camel.component.aws-sqs.maximumMessageSize

The maximumMessageSize (in bytes) an SQS message can contain for this queue.

null

false

MEDIUM

camel.component.aws-sqs.messageRetentionPeriod

The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue.

null

false

MEDIUM

camel.component.aws-sqs.policy

The policy for this queue

null

false

MEDIUM

camel.component.aws-sqs.receiveMessageWaitTime Seconds

If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait.

null

false

MEDIUM

camel.component.aws-sqs.redrivePolicy

Specify the policy that send message to DeadLetter queue. See detail at Amazon docs.

null

false

MEDIUM

camel.component.aws-sqs.accessKey

Amazon AWS Access Key

null

false

MEDIUM

camel.component.aws-sqs.secretKey

Amazon AWS Secret Key

null

false

MEDIUM

The camel-aws-sqs sink connector has no converters out of the box.

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

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