| // kafka-connector options: START |
| [[camel-aws-sqs-kafka-connector-source]] |
| = camel-aws-sqs-kafka-connector source configuration |
| |
| When using camel-aws-sqs-kafka-connector as source 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 source connector supports 60 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.source.path.queueNameOr Arn* | Queue name or ARN | null | ConfigDef.Importance.HIGH |
| | * camel.source.endpoint.amazonAWS Host* | The hostname of the Amazon AWS cloud. | "amazonaws.com" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.amazonSQS Client* | To use the AmazonSQS as client | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.auto CreateQueue* | Setting the autocreation of the queue | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.header FilterStrategy* | To use a custom HeaderFilterStrategy to map headers to/from Camel. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.protocol* | The underlying protocol used to communicate with SQS | "https" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.proxy Protocol* | To define a proxy protocol when instantiating the SQS client One of: [HTTP] [HTTPS] | "HTTPS" | ConfigDef.Importance.MEDIUM |
| | *camel.source.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.source.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.source.endpoint.attribute Names* | A list of attribute names to receive when consuming. Multiple names can be separated by comma. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.bridge ErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.concurrent Consumers* | Allows you to use multiple threads to poll the sqs queue to increase throughput | 1 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.default VisibilityTimeout* | The default visibility timeout (in seconds) | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.delete AfterRead* | Delete message from SQS after it has been read | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.deleteIf Filtered* | Whether or not to send the DeleteMessage to the SQS queue if an exchange fails to get through a filter. If 'false' and exchange does not make it through a Camel filter upstream in the route, then don't send DeleteMessage. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.extend MessageVisibility* | If enabled then a scheduled background task will keep extending the message visibility on SQS. This is needed if it takes a long time to process the message. If set to true defaultVisibilityTimeout must be set. See details at Amazon docs. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.kmsData KeyReusePeriodSeconds* | The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.kms MasterKeyId* | The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.max MessagesPerPoll* | Gets the maximum number of messages as a limit to poll at each polling. Is default unlimited, but use 0 or negative number to disable it as unlimited. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.message AttributeNames* | A list of message attribute names to receive when consuming. Multiple names can be separated by comma. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.send EmptyMessageWhenIdle* | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.server SideEncryptionEnabled* | Define if Server Side Encryption is enabled or not on the queue | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.visibility Timeout* | The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request to set in the com.amazonaws.services.sqs.model.SetQueueAttributesRequest. This only make sense if its different from defaultVisibilityTimeout. It changes the queue visibility timeout attribute permanently. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.waitTime Seconds* | Duration in seconds (0 to 20) that the ReceiveMessage action call will wait until a message is in the queue to include in the response. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.exception Handler* | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.poll Strategy* | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.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.source.endpoint.delay Queue* | Define if you want to apply delaySeconds option to the queue or on single messages | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.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.source.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.source.endpoint.backoff ErrorThreshold* | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.backoff IdleThreshold* | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.backoff Multiplier* | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.delay* | Milliseconds before the next poll. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour). | 500L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.greedy* | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.initial Delay* | Milliseconds before the first poll starts. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour). | 1000L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.repeat Count* | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.run LoggingLevel* | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF] | "TRACE" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.scheduled ExecutorService* | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.scheduler* | To use a cron scheduler from either camel-spring or camel-quartz component One of: [none] [spring] [quartz] | "none" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.scheduler Properties* | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.start Scheduler* | Whether the scheduler should be auto started. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.timeUnit* | Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS] | "MILLISECONDS" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.useFixed Delay* | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.proxy Host* | To define a proxy host when instantiating the SQS client | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.proxy Port* | To define a proxy port when instantiating the SQS client | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.maximum MessageSize* | The maximumMessageSize (in bytes) an SQS message can contain for this queue. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.message RetentionPeriod* | The messageRetentionPeriod (in seconds) a message will be retained by SQS for this queue. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.policy* | The policy for this queue | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.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.source.endpoint.redrive Policy* | Specify the policy that send message to DeadLetter queue. See detail at Amazon docs. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.access Key* | Amazon AWS Access Key | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.secret Key* | 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.bridge ErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | 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 |
