Defines the AWS S3 Endpoint.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| bucketName | path | common | true | java.lang.String | Name of the bucket. The bucket will be created if it don't already exists. | ||
| accessKey | parameter | common | java.lang.String | Amazon AWS Access Key | |||
| amazonS3Client | parameter | common | com.amazonaws.services.s3.AmazonS3 | To use the AmazonS3 as the client | |||
| amazonS3Endpoint | parameter | common | java.lang.String | The region with which the AWS-S3 client wants to work with. | |||
| policy | parameter | common | java.lang.String | The policy for this bucket | |||
| proxyHost | parameter | common | java.lang.String | To define a proxy host when instantiating the SQS client | |||
| proxyPort | parameter | common | java.lang.Integer | To define a proxy port when instantiating the SQS client | |||
| secretKey | parameter | common | java.lang.String | Amazon AWS Secret Key | |||
| deleteAfterRead | parameter | consumer | true | boolean | Delete objects from S3 after it has been retrieved. | ||
| fileName | parameter | consumer | java.lang.String | To get the object from the bucket with the given file name | |||
| maxMessagesPerPoll | parameter | consumer | 10 | int | 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. | ||
| prefix | parameter | consumer | java.lang.String | The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. | |||
| sendEmptyMessageWhenIdle | parameter | consumer | boolean | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | |||
| pollStrategy | parameter | consumer (advanced) | org.apache.camel.spi.PollingConsumerPollStrategy | 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. | |||
| deleteAfterWrite | parameter | producer | boolean | Delete file object after the S3 file has been uploaded | |||
| multiPartUpload | parameter | producer | boolean | If it is true, Camel will upload the file with multi part format, the part size is decided by the option of partSize | |||
| partSize | parameter | producer | 26214400 | long | Setup the partSize which is used in multi part upload, the default size is 25M. | ||
| region | parameter | producer | java.lang.String | The region where the bucket is located. | |||
| serverSideEncryption | parameter | producer | java.lang.String | Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256. | |||
| storageClass | parameter | producer | java.lang.String | The storage class | |||
| exchangePattern | parameter | advanced | InOnly | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the default exchange pattern when creating an exchange | |
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | ||
| backoffErrorThreshold | parameter | scheduler | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | |||
| backoffIdleThreshold | parameter | scheduler | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | |||
| backoffMultiplier | parameter | scheduler | int | 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. | |||
| delay | parameter | scheduler | 500 | long | Milliseconds before the next poll. | ||
| greedy | parameter | scheduler | boolean | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | |||
| initialDelay | parameter | scheduler | 1000 | long | Milliseconds before the first poll starts. | ||
| runLoggingLevel | parameter | scheduler | TRACE | org.apache.camel.LoggingLevel | TRACE DEBUG INFO WARN ERROR OFF |
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | |
| scheduledExecutorService | parameter | scheduler | java.util.concurrent.ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | |||
| scheduler | parameter | scheduler | org.apache.camel.spi.ScheduledPollConsumerScheduler | spring quartz2 |
To use a cron scheduler from either camel-spring or camel-quartz2 component | ||
| schedulerProperties | parameter | scheduler | java.util.Map |
To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler. | |||
| startScheduler | parameter | scheduler | true | boolean | Whether the scheduler should be auto started. | ||
| timeUnit | parameter | scheduler | MILLISECONDS | java.util.concurrent.TimeUnit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS |
Time unit for initialDelay and delay options. | |
| useFixedDelay | parameter | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |
A Consumer of messages from the Amazon Web Service Simple Storage Service AWS S3