camel-aws2-sqs-kafka-connector sink configuration

Connector Description: Sending and receive messages to/from AWS SQS service using AWS SDK version 2.x.

When using camel-aws2-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-aws2-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.aws2sqs.CamelAws2sqsSinkConnector

The camel-aws2-sqs sink connector supports 60 options, which are listed below.

Name Description Default Priority

camel.sink.path.queueNameOrArn

Required Queue name or ARN.

HIGH

camel.sink.endpoint.amazonAWSHost

The hostname of the Amazon AWS cloud.

"amazonaws.com"

MEDIUM

camel.sink.endpoint.amazonSQSClient

To use the AmazonSQS as client.

MEDIUM

camel.sink.endpoint.autoCreateQueue

Setting the autocreation of the queue.

false

MEDIUM

camel.sink.endpoint.headerFilterStrategy

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

MEDIUM

camel.sink.endpoint.overrideEndpoint

Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option.

false

MEDIUM

camel.sink.endpoint.protocol

The underlying protocol used to communicate with SQS.

"https"

MEDIUM

camel.sink.endpoint.proxyProtocol

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

Enum values:

  • HTTP

  • HTTPS

"HTTPS"

MEDIUM

camel.sink.endpoint.queueOwnerAWSAccountId

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

MEDIUM

camel.sink.endpoint.region

The region in which SQS 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().

MEDIUM

camel.sink.endpoint.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint.

false

MEDIUM

camel.sink.endpoint.uriEndpointOverride

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option.

MEDIUM

camel.sink.endpoint.useDefaultCredentialsProvider

Set whether the SQS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in.

false

MEDIUM

camel.sink.endpoint.batchSeparator

Set the separator when passing a String to send batch message operation.

","

MEDIUM

camel.sink.endpoint.delaySeconds

Delay sending messages for a number of seconds.

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

Enum values:

  • useExchangeId

  • useContentBasedDeduplication

"useExchangeId"

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

Enum values:

  • useConstant

  • useExchangeId

  • usePropertyValue

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] [purgeQueue].

Enum values:

  • sendBatchMessage

  • deleteMessage

  • listQueues

  • purgeQueue

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.

MEDIUM

camel.sink.endpoint.proxyHost

To define a proxy host when instantiating the SQS client.

MEDIUM

camel.sink.endpoint.proxyPort

To define a proxy port when instantiating the SQS client.

MEDIUM

camel.sink.endpoint.maximumMessageSize

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

MEDIUM

camel.sink.endpoint.messageRetentionPeriod

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

MEDIUM

camel.sink.endpoint.policy

The policy for this queue. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.

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.

MEDIUM

camel.sink.endpoint.redrivePolicy

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

MEDIUM

camel.sink.endpoint.accessKey

Amazon AWS Access Key.

MEDIUM

camel.sink.endpoint.secretKey

Amazon AWS Secret Key.

MEDIUM

camel.component.aws2-sqs.amazonAWSHost

The hostname of the Amazon AWS cloud.

"amazonaws.com"

MEDIUM

camel.component.aws2-sqs.amazonSQSClient

To use the AmazonSQS as client.

MEDIUM

camel.component.aws2-sqs.autoCreateQueue

Setting the autocreation of the queue.

false

MEDIUM

camel.component.aws2-sqs.configuration

The AWS SQS default configuration.

MEDIUM

camel.component.aws2-sqs.overrideEndpoint

Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option.

false

MEDIUM

camel.component.aws2-sqs.protocol

The underlying protocol used to communicate with SQS.

"https"

MEDIUM

camel.component.aws2-sqs.proxyProtocol

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

Enum values:

  • HTTP

  • HTTPS

"HTTPS"

MEDIUM

camel.component.aws2-sqs.queueOwnerAWSAccountId

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

MEDIUM

camel.component.aws2-sqs.region

The region in which SQS 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().

MEDIUM

camel.component.aws2-sqs.trustAllCertificates

If we want to trust all certificates in case of overriding the endpoint.

false

MEDIUM

camel.component.aws2-sqs.uriEndpointOverride

Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option.

MEDIUM

camel.component.aws2-sqs.useDefaultCredentialsProvider

Set whether the SQS client should expect to load credentials on an AWS infra instance or to expect static credentials to be passed in.

false

MEDIUM

camel.component.aws2-sqs.batchSeparator

Set the separator when passing a String to send batch message operation.

","

MEDIUM

camel.component.aws2-sqs.delaySeconds

Delay sending messages for a number of seconds.

MEDIUM

camel.component.aws2-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

MEDIUM

camel.component.aws2-sqs.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].

Enum values:

  • useExchangeId

  • useContentBasedDeduplication

"useExchangeId"

MEDIUM

camel.component.aws2-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].

Enum values:

  • useConstant

  • useExchangeId

  • usePropertyValue

MEDIUM

camel.component.aws2-sqs.operation

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

Enum values:

  • sendBatchMessage

  • deleteMessage

  • listQueues

  • purgeQueue

MEDIUM

camel.component.aws2-sqs.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

camel.component.aws2-sqs.delayQueue

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

false

MEDIUM

camel.component.aws2-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.

MEDIUM

camel.component.aws2-sqs.proxyHost

To define a proxy host when instantiating the SQS client.

MEDIUM

camel.component.aws2-sqs.proxyPort

To define a proxy port when instantiating the SQS client.

MEDIUM

camel.component.aws2-sqs.maximumMessageSize

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

MEDIUM

camel.component.aws2-sqs.messageRetentionPeriod

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

MEDIUM

camel.component.aws2-sqs.policy

The policy for this queue. It can be loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.

MEDIUM

camel.component.aws2-sqs.receiveMessageWaitTimeSeconds

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

MEDIUM

camel.component.aws2-sqs.redrivePolicy

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

MEDIUM

camel.component.aws2-sqs.accessKey

Amazon AWS Access Key.

MEDIUM

camel.component.aws2-sqs.secretKey

Amazon AWS Secret Key.

MEDIUM

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

The camel-aws2-sqs sink connector supports 1 transforms out of the box, which are listed below.

  • org.apache.camel.kafkaconnector.aws2sqs.transformers.SQSKeySetterTransforms

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

Back to top