Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URI Format

Code Block
aws-s3://bucket-namebucketName[?options]
aws-s3://bucketNameOrArn[?options]
 (Camel 2.18 onwards)

The bucket will be created if it don't already exists.
You can append query options to the URI in the following format, ?options=value&option2=value&...

...

Name

Default Value

Context

Description

amazonS3Client

null

Shared

Reference to a com.amazonaws.services.sqs.AmazonS3 in the Registry.

accessKey

null

Shared

Amazon AWS Access Key

secretKey

null

Shared

Amazon AWS Secret Key

amazonS3Endpoint

null

Shared

The region with which the AWS-S3 client wants to work with.

region

null

Producer

The region who the bucket is located. This option is used in the com.amazonaws.services.s3.model.CreateBucketRequest.

deleteAfterRead

true

Consumer

Delete objects from S3 after it has been retrieved.

deleteAfterWrite

false

Producer

Camel 2.11.0 Delete file object after the S3 file has been uploaded

maxMessagesPerPoll

10

Consumer

The maximum number of objects which can be retrieved in one poll. Used in in the com.amazonaws.services.s3.model.ListObjectsRequest.

policy

null

Shared

Camel 2.8.4: The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.

storageClass

null

Producer

Camel 2.8.4: The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.

prefix

null

Consumer

Camel 2.10.1: The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.

multiPartUpload

falseProducerCamel 2.15.0: If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize

partSize

25 * 1024 * 1024

ProducerCamel 2.15.0: Setup the partSize which is used in multi part upload, the default size is 25M.
serverSideEncryptionnullProducerCamel 2.16: Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256.
proxyHostnullProducerCamel 2.16: Specify a proxy host to be used inside the client definition.
proxyPortnullProducerCamel 2.16: Specify a proxy port to be used inside the client definition.
includeBodytrueConsumerCamel 2.17: If it is true the exchange body will be set to a stream to the contents of the file. If false the headers will be set with the S3 object metadata but the body will be null.
operationnullProducerCamel 2.18: The operation to perform in case the end-user don't want to do a simple upload. Values can be: copyObject, listBuckets, deleteBucket
Info
titleRequired S3 component options

You have to provide the amazonS3Client in the Registry or your accessKey and secretKey to access the Amazon's S3.

...

Div
classconfluenceTableSmall

Header

Type

Description

CamelAwsS3Key

String

The key under which this object will be stored or which will be used for the current operation.

CamelAwsS3BucketName

String

Camel 2.18: The bucket Name which this object will be stored or which will be used for the current operation

CamelAwsS3BucketDestinationName

String

Camel 2.18: The bucket Destination Name which will be used for the current operation

CamelAwsS3ContentLength

Long

The content length of this object.

CamelAwsS3ContentType

String

The content type of this object.

CamelAwsS3ContentControl

String

Camel 2.8.2: The content control of this object.

CamelAwsS3ContentDisposition

String

Camel 2.8.2: The content disposition of this object.

CamelAwsS3ContentEncoding

String

Camel 2.8.2: The content encoding of this object.

CamelAwsS3ContentMD5

String

Camel 2.8.2: The md5 checksum of this object.

CamelAwsS3DestinationKey

String

Camel 2.18: The Destination key which will be used for the current operation

CamelAwsS3LastModified

java.util.Date

Camel 2.8.2: The last modified timestamp of this object.

CamelAwsS3Operation

String

Camel 2.18: The operation to perform. Values can be: copyObject, listBuckets, deleteBucket

CamelAwsS3StorageClass

String

Camel 2.8.4: The storage class of this object.

CamelAwsS3CannedAcl

String

Camel 2.11.0: The canned acl that will be applied to the object. see com.amazonaws.services.s3.model.CannedAccessControlList for allowed values.

CamelAwsS3Acl

com.amazonaws.services.s3.model.AccessControlList

Camel 2.11.0: a well constructed Amazon S3 Access Control List object. see com.amazonaws.services.s3.model.AccessControlList for more details

CamelAwsS3HeadersMap<String,String>Camel 2.15.0: support to get or set custom objectMetadata headers.
CamelAwsS3ServerSideEncryptionStringCamel 2.16: Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256.

...