| // kafka-connector options: START |
| [[camel-aws-sqs-kafka-connector-sink]] |
| = 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: |
| |
| [source,xml] |
| ---- |
| <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> |
| ---- |
| |
| |
| The camel-aws-sqs sink connector supports 33 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.sink.path.queueNameOrArn* | Queue name or ARN | null | ConfigDef.Importance.HIGH |
| | *camel.sink.endpoint.amazonAWS Host* | The hostname of the Amazon AWS cloud. | "amazonaws.com" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.amazonSQS Client* | To use the AmazonSQS as client | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.autoCreate Queue* | Setting the autocreation of the queue | true | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.header FilterStrategy* | To use a custom HeaderFilterStrategy to map headers to/from Camel. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.protocol* | The underlying protocol used to communicate with SQS | "https" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxy Protocol* | To define a proxy protocol when instantiating the SQS client One of: [HTTP] [HTTPS] | "HTTPS" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.queue OwnerAWSAccountId* | Specify the queue owner aws account id when you need to connect the queue with different account owner. | null | ConfigDef.Importance.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 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.delay Seconds* | Delay sending messages for a number of seconds. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.lazyStart Producer* | 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 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.message DeduplicationIdStrategy* | 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" | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.message GroupIdStrategy* | 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 | ConfigDef.Importance.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 | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.delayQueue* | Define if you want to apply delaySeconds option to the queue or on single messages | false | ConfigDef.Importance.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 | ConfigDef.Importance.MEDIUM |
| | * camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxyHost* | To define a proxy host when instantiating the SQS client | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.proxyPort* | To define a proxy port when instantiating the SQS client | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.maximum MessageSize* | The maximumMessageSize (in bytes) an SQS message can contain for this queue. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.message RetentionPeriod* | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.policy* | The policy for this queue | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.receive MessageWaitTimeSeconds* | If you do not specify WaitTimeSeconds in the request, the queue attribute ReceiveMessageWaitTimeSeconds is used to determine how long to wait. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.redrive Policy* | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.accessKey* | Amazon AWS Access Key | null | ConfigDef.Importance.MEDIUM |
| | *camel.sink.endpoint.secretKey* | Amazon AWS Secret Key | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.aws-sqs.access Key* | Amazon AWS Access Key | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.aws-sqs.region* | Specify the queue region which could be used with queueOwnerAWSAccountId to build the service URL. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.aws-sqs.secret Key* | Amazon AWS Secret Key | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.aws-sqs.lazy StartProducer* | 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 | ConfigDef.Importance.MEDIUM |
| | *camel.component.aws-sqs.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.aws-sqs.configuration* | The AWS SQS default configuration | null | ConfigDef.Importance.MEDIUM |
| |=== |
| // kafka-connector options: END |
