AWS S3 Storage Service

Store and retrieve objects from AWS S3 Storage Service.

Metadata

Property	Value
Scheme	`aws2-s3`
Support Level	Stable
Labels	cloud,file
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-aws2-s3</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`bucketNameOrArn`	string	✓		Bucket name or ARN
`autoCreateBucket`	boolean		`false`	Setting the autocreation of the S3 bucket bucketName. This will apply also in case of moveAfterRead option enabled, and it will create the destinationBucket if it doesn't exist already.
`delimiter`	string			The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
`forcePathStyle`	boolean		`false`	Set whether the S3 client should use path-style URL instead of virtual-hosted-style
`ignoreBody`	boolean		`false`	If it is true, the S3 Object Body will be ignored completely if it is set to false, the S3 Object will be put in the body. Setting this to true will override any behavior defined by includeBody option.
`overrideEndpoint`	boolean		`false`	Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option
`pojoRequest`	boolean		`false`	If we want to use a POJO request as body or not
`policy`	string			The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.
`prefix`	string			The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
`region`	string			The region in which the S3 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()
`uriEndpointOverride`	string			Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option
`customerAlgorithm`	string			Define the customer algorithm to use in case CustomerKey is enabled
`customerKeyId`	string			Define the id of the Customer key to use in case CustomerKey is enabled
`customerKeyMD5`	string			Define the MD5 of Customer key to use in case CustomerKey is enabled
`deleteAfterRead`	boolean		`true`	Delete objects from S3 after they have been retrieved. The deleting is only performed if the Exchange is committed. If a rollback occurs, the object is not deleted. If this option is false, then the same objects will be retrieved over and over again in the polls. Therefore, you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY headers, or only the AWS2S3Constants#KEY header.
`destinationBucket`	string			Define the destination bucket where an object must be moved when moveAfterRead is set to true.
`destinationBucketPrefix`	string			Define the destination bucket prefix to use when an object must be moved, and moveAfterRead is set to true.
`destinationBucketSuffix`	string			Define the destination bucket suffix to use when an object must be moved, and moveAfterRead is set to true.
`doneFileName`	string			If provided, Camel will only consume files if a done file exists.
`fileName`	string			To get the object from the bucket with the given file name
`includeBody`	boolean		`true`	If it is true, the S3Object exchange will be consumed and put into the body and closed. If false, the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata. This option is strongly related to the autocloseBody option. In case of setting includeBody to true because the S3Object stream will be consumed then it will also be closed, while in case of includeBody false then it will be up to the caller to close the S3Object stream. However, setting autocloseBody to true when includeBody is false it will schedule to close the S3Object stream automatically on exchange completion.
`includeFolders`	boolean		`true`	If it is true, the folders/directories will be consumed. If it is false, they will be ignored, and Exchanges will not be created for those
`maxConnections`	integer		`60`	Set the maxConnections parameter in the S3 client configuration
`maxMessagesPerPoll`	integer		`10`	Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited.
`moveAfterRead`	boolean		`false`	Move objects from S3 bucket to a different bucket after they have been retrieved. To accomplish the operation, the destinationBucket option must be set. The copy bucket operation is only performed if the Exchange is committed. If a rollback occurs, the object is not moved.
`sendEmptyMessageWhenIdle`	boolean		`false`	If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`autocloseBody`	boolean		`true`	If this option is true and includeBody is false, then the S3Object.close() method will be called on exchange completion. This option is strongly related to includeBody option. In case of setting includeBody to false and autocloseBody to false, it will be up to the caller to close the S3Object stream. Setting autocloseBody to true, will close the S3Object stream automatically.
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.
`exceptionHandler`	object			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.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`inProgressRepository`	object			A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used.
`pollStrategy`	object			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.
`batchMessageNumber`	integer		`10`	The number of messages composing a batch in streaming upload mode
`batchSize`	integer		`1000000`	The batch size (in bytes) in streaming upload mode
`bufferSize`	integer		`1000000`	The buffer size (in bytes) in streaming upload mode
`deleteAfterWrite`	boolean		`false`	Delete file object after the S3 file has been uploaded
`keyName`	string			Setting the key name for an element in the bucket through endpoint parameter
`multiPartUpload`	boolean		`false`	If it is true, camel will upload the file with multipart format. The part size is decided by the partSize option. Camel will only do multipart uploads for files that are larger than the part-size thresholds. Files that are smaller will be uploaded in a single operation.
`namingStrategy`	object		`progressive`	The naming strategy to use in streaming upload mode
`operation`	object			The operation to do in case the user don't want to do only an upload
`partSize`	integer		`26214400`	Set up the partSize which is used in multipart upload, the default size is 25M. Camel will only do multipart uploads for files that are larger than the part-size thresholds. Files that are smaller will be uploaded in a single operation.
`restartingPolicy`	object		`override`	The restarting policy to use in streaming upload mode
`storageClass`	string			The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.
`streamingUploadMode`	boolean		`false`	When stream mode is true, the upload to bucket will be done in streaming
`streamingUploadTimeout`	integer			While streaming upload mode is true, this option set the timeout to complete upload
`awsKMSKeyId`	string			Define the id of KMS key to use in case KMS is enabled
`conditionalWritesEnabled`	boolean		`false`	Uploads the object only if the object key name does not already exist in the bucket specified.
`lazyStartProducer`	boolean		`false`	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.
`useAwsKMS`	boolean		`false`	Define if KMS must be used or not
`useCustomerKey`	boolean		`false`	Define if Customer Key must be used or not
`useSSES3`	boolean		`false`	Define if SSE S3 must be used or not
`amazonS3Client`	object			Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.
`amazonS3Presigner`	object			An S3 Presigner for Request, used mainly in createDownloadLink operation
`proxyHost`	string			To define a proxy host when instantiating the SQS client
`proxyPort`	integer			Specify a proxy port to be used inside the client definition.
`proxyProtocol`	object		`HTTPS`	To define a proxy protocol when instantiating the S3 client
`backoffErrorThreshold`	integer			The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`backoffIdleThreshold`	integer			The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`backoffMultiplier`	integer			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`	integer		`500`	Milliseconds before the next poll.
`greedy`	boolean		`false`	If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`initialDelay`	integer		`1000`	Milliseconds before the first poll starts.
`repeatCount`	integer		`0`	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.
`runLoggingLevel`	object		`TRACE`	The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
`scheduledExecutorService`	object			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`	object		`none`	To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler
`schedulerProperties`	object			To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`startScheduler`	boolean		`true`	Whether the scheduler should be auto started.
`timeUnit`	object		`MILLISECONDS`	Time unit for initialDelay and delay options.
`useFixedDelay`	boolean		`true`	Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
`accessKey`	string			Amazon AWS Access Key
`profileCredentialsName`	string			If using a profile credentials provider, this parameter will set the profile name
`secretKey`	string			Amazon AWS Secret Key
`sessionToken`	string			Amazon AWS Session Token used when the user needs to assume an IAM role
`trustAllCertificates`	boolean		`false`	If we want to trust all certificates in case of overriding the endpoint
`useDefaultCredentialsProvider`	boolean		`false`	Set whether the S3 client should expect to load credentials through a default credentials provider.
`useProfileCredentialsProvider`	boolean		`false`	Set whether the S3 client should expect to load credentials through a profile credentials provider.
`useSessionCredentials`	boolean		`false`	Set whether the S3 client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume an IAM role for doing operations in S3.