Camel Spring Boot Starter for aws-s3

Spring Boot Auto-Configuration

When using aws-s3 with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-aws-s3-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 40 options, which are listed below.

Name Description Default Type

camel.component.aws-s3.accelerate-mode-enabled

Define if Accelerate Mode enabled is true or false

false

Boolean

camel.component.aws-s3.access-key

Amazon AWS Access Key

String

camel.component.aws-s3.amazon-s3-client

Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option is a com.amazonaws.services.s3.AmazonS3 type.

AmazonS3

camel.component.aws-s3.auto-create-bucket

Setting the autocreation of the bucket

true

Boolean

camel.component.aws-s3.auto-discover-client

Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking.

true

Boolean

camel.component.aws-s3.autoclose-body

If this option is true and includeBody is true, 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 true 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.

true

Boolean

camel.component.aws-s3.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.aws-s3.aws-k-m-s-key-id

Define the id of KMS key to use in case KMS is enabled

String

camel.component.aws-s3.bridge-error-handler

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

Boolean

camel.component.aws-s3.chunked-encoding-disabled

Define if disabled Chunked Encoding is true or false

false

Boolean

camel.component.aws-s3.configuration

The component configuration. The option is a org.apache.camel.component.aws.s3.S3Configuration type.

S3Configuration

camel.component.aws-s3.delete-after-read

Delete objects from S3 after they have been retrieved. The delete 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 retrieve over and over again on the polls. Therefore you need to use the Idempotent Consumer EIP in the route to filter out duplicates. You can filter using the S3Constants#BUCKET_NAME and S3Constants#KEY headers, or only the S3Constants#KEY header.

true

Boolean

camel.component.aws-s3.delete-after-write

Delete file object after the S3 file has been uploaded

false

Boolean

camel.component.aws-s3.delimiter

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

String

camel.component.aws-s3.dualstack-enabled

Define if Dualstack enabled is true or false

false

Boolean

camel.component.aws-s3.enabled

Whether to enable auto configuration of the aws-s3 component. This is enabled by default.

Boolean

camel.component.aws-s3.encryption-materials

The encryption materials to use in case of Symmetric/Asymmetric client usage. The option is a com.amazonaws.services.s3.model.EncryptionMaterials type.

EncryptionMaterials

camel.component.aws-s3.endpoint-configuration

Amazon AWS Endpoint Configuration. The option is a com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration type.

AwsClientBuilder$EndpointConfiguration

camel.component.aws-s3.file-name

To get the object from the bucket with the given file name

String

camel.component.aws-s3.force-global-bucket-access-enabled

Define if Force Global Bucket Access enabled is true or false

false

Boolean

camel.component.aws-s3.include-body

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. This option is strongly related to autocloseBody option. In case of setting includeBody to true 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.

true

Boolean

camel.component.aws-s3.key-name

Setting the key name for an element in the bucket through endpoint parameter

String

camel.component.aws-s3.lazy-start-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

Boolean

camel.component.aws-s3.multi-part-upload

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

false

Boolean

camel.component.aws-s3.operation

The operation to do in case the user don’t want to do only an upload

S3Operations

camel.component.aws-s3.part-size

Setup the partSize which is used in multi part upload, the default size is 25M.

26214400

Long

camel.component.aws-s3.path-style-access

Whether or not the S3 client should use path style access

false

Boolean

camel.component.aws-s3.payload-signing-enabled

Define if Payload Signing enabled is true or false

false

Boolean

camel.component.aws-s3.policy

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

String

camel.component.aws-s3.prefix

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

String

camel.component.aws-s3.proxy-host

To define a proxy host when instantiating the S3 client

String

camel.component.aws-s3.proxy-port

Specify a proxy port to be used inside the client definition.

Integer

camel.component.aws-s3.proxy-protocol

To define a proxy protocol when instantiating the S3 client

Protocol

camel.component.aws-s3.region

The region in which S3 client needs to work. 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()

String

camel.component.aws-s3.secret-key

Amazon AWS Secret Key

String

camel.component.aws-s3.server-side-encryption

Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256.

String

camel.component.aws-s3.storage-class

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

String

camel.component.aws-s3.use-aws-k-m-s

Define if KMS must be used or not

false

Boolean

camel.component.aws-s3.use-encryption

Define if encryption must be used or not

false

Boolean

camel.component.aws-s3.use-i-a-m-credentials

Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in.

false

Boolean