Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.aws2.s3.AWS2S3Component>

All Known Implementing Classes:

Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilderImpl

Enclosing interface:

Aws2S3ComponentBuilderFactory
```
public static interface Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws2.s3.AWS2S3Component>
```
Builder for the AWS 2 S3 Storage Service component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`amazonS3Client(software.amazon.awssdk.services.s3.S3Client amazonS3Client)` Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`autocloseBody(boolean autocloseBody)` If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`autoCreateBucket(boolean autoCreateBucket)` Setting the autocreation of the bucket.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`awsKMSKeyId(String awsKMSKeyId)` Define the id of KMS key to use in case KMS is enabled.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` 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.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`configuration(org.apache.camel.component.aws2.s3.AWS2S3Configuration configuration)` The component configuration.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`customerAlgorithm(String customerAlgorithm)` Define the customer algorithm to use in case CustomerKey is enabled.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`customerKeyId(String customerKeyId)` Define the id of Customer key to use in case CustomerKey is enabled.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`customerKeyMD5(String customerKeyMD5)` Define the MD5 of Customer key to use in case CustomerKey is enabled.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`deleteAfterRead(boolean deleteAfterRead)` Delete objects from S3 after they have been retrieved.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`deleteAfterWrite(boolean deleteAfterWrite)` Delete file object after the S3 file has been uploaded.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`delimiter(String delimiter)` The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`destinationBucket(String destinationBucket)` Define the destination bucket where an object must be moved when moveAfterRead is set to true.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`fileName(String fileName)` To get the object from the bucket with the given file name.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`includeBody(boolean includeBody)` If it is true, the exchange body will be set to a stream to the contents of the file.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`includeFolders(boolean includeFolders)` If it is true, the folders/directories will be consumed.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`keyName(String keyName)` Setting the key name for an element in the bucket through endpoint parameter.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`moveAfterRead(boolean moveAfterRead)` Move objects from S3 bucket to a different bucket after they have been retrieved.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`multiPartUpload(boolean multiPartUpload)` If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`operation(org.apache.camel.component.aws2.s3.AWS2S3Operations operation)` The operation to do in case the user don't want to do only an upload.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`overrideEndpoint(boolean overrideEndpoint)` Set the need for overidding the endpoint.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`partSize(long partSize)` Setup the partSize which is used in multi part upload, the default size is 25M.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`pojoRequest(boolean pojoRequest)` If we want to use a POJO request as body or not.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`policy(String policy)` The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`prefix(String prefix)` The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the SQS client.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`proxyPort(Integer proxyPort)` Specify a proxy port to be used inside the client definition.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)` To define a proxy protocol when instantiating the S3 client.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`region(String region)` The region in which S3 client needs to work.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`storageClass(String storageClass)` The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`uriEndpointOverride(String uriEndpointOverride)` Set the overriding uri endpoint.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`useAwsKMS(boolean useAwsKMS)` Define if KMS must be used or not.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`useCustomerKey(boolean useCustomerKey)` Define if Customer Key must be used or not.
`default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder`	`useIAMCredentials(boolean useIAMCredentials)` Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - amazonS3Client
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder amazonS3Client(software.amazon.awssdk.services.s3.S3Client amazonS3Client)
```
    Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option is a: software.amazon.awssdk.services.s3.S3Client type. Group: common
  - autoCreateBucket
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder autoCreateBucket(boolean autoCreateBucket)
```
    Setting the autocreation of the bucket. The option is a: boolean type. Default: true Group: common
  - configuration
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder configuration(org.apache.camel.component.aws2.s3.AWS2S3Configuration configuration)
```
    The component configuration. The option is a: org.apache.camel.component.aws2.s3.AWS2S3Configuration type. Group: common
  - overrideEndpoint
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder overrideEndpoint(boolean overrideEndpoint)
```
    Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option. The option is a: boolean type. Default: false Group: common
  - pojoRequest
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder pojoRequest(boolean pojoRequest)
```
    If we want to use a POJO request as body or not. The option is a: boolean type. Default: false Group: common
  - policy
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder policy(String policy)
```
    The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method. The option is a: java.lang.String type. Group: common
  - proxyHost
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder proxyHost(String proxyHost)
```
    To define a proxy host when instantiating the SQS client. The option is a: java.lang.String type. Group: common
  - proxyPort
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder proxyPort(Integer proxyPort)
```
    Specify a proxy port to be used inside the client definition. The option is a: java.lang.Integer type. Group: common
  - proxyProtocol
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder proxyProtocol(software.amazon.awssdk.core.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the S3 client. The option is a: software.amazon.awssdk.core.Protocol type. Default: HTTPS Group: common
  - region
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder region(String region)
```
    The region in which 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(). The option is a: java.lang.String type. Group: common
  - uriEndpointOverride
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder uriEndpointOverride(String uriEndpointOverride)
```
    Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option. The option is a: java.lang.String type. Group: common
  - useIAMCredentials
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder useIAMCredentials(boolean useIAMCredentials)
```
    Set whether the S3 client should expect to load credentials on an EC2 instance or to expect static credentials to be passed in. The option is a: boolean type. Default: false Group: common
  - bridgeErrorHandler
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    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. The option is a: boolean type. Default: false Group: consumer
  - deleteAfterRead
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder deleteAfterRead(boolean deleteAfterRead)
```
    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 AWS2S3Constants#BUCKET_NAME and AWS2S3Constants#KEY headers, or only the AWS2S3Constants#KEY header. The option is a: boolean type. Default: true Group: consumer
  - delimiter
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder delimiter(String delimiter)
```
    The delimiter which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. The option is a: java.lang.String type. Group: consumer
  - destinationBucket
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder destinationBucket(String destinationBucket)
```
    Define the destination bucket where an object must be moved when moveAfterRead is set to true. The option is a: java.lang.String type. Group: consumer
  - fileName
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder fileName(String fileName)
```
    To get the object from the bucket with the given file name. The option is a: java.lang.String type. Group: consumer
  - includeBody
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder includeBody(boolean includeBody)
```
    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. The option is a: boolean type. Default: true Group: consumer
  - includeFolders
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder includeFolders(boolean includeFolders)
```
    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. The option is a: boolean type. Default: true Group: consumer
  - moveAfterRead
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder moveAfterRead(boolean moveAfterRead)
```
    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. The option is a: boolean type. Default: false Group: consumer
  - prefix
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder prefix(String prefix)
```
    The prefix which is used in the com.amazonaws.services.s3.model.ListObjectsRequest to only consume objects we are interested in. The option is a: java.lang.String type. Group: consumer
  - autocloseBody
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder autocloseBody(boolean autocloseBody)
```
    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. The option is a: boolean type. Default: true Group: consumer (advanced)
  - deleteAfterWrite
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder deleteAfterWrite(boolean deleteAfterWrite)
```
    Delete file object after the S3 file has been uploaded. The option is a: boolean type. Default: false Group: producer
  - keyName
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder keyName(String keyName)
```
    Setting the key name for an element in the bucket through endpoint parameter. The option is a: java.lang.String type. Group: producer
  - lazyStartProducer
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder lazyStartProducer(boolean lazyStartProducer)
```
    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. The option is a: boolean type. Default: false Group: producer
  - multiPartUpload
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder multiPartUpload(boolean multiPartUpload)
```
    If it is true, camel will upload the file with multi part format, the part size is decided by the option of partSize. The option is a: boolean type. Default: false Group: producer
  - operation
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder operation(org.apache.camel.component.aws2.s3.AWS2S3Operations operation)
```
    The operation to do in case the user don't want to do only an upload. The option is a: org.apache.camel.component.aws2.s3.AWS2S3Operations type. Group: producer
  - partSize
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder partSize(long partSize)
```
    Setup the partSize which is used in multi part upload, the default size is 25M. The option is a: long type. Default: 26214400 Group: producer
  - storageClass
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder storageClass(String storageClass)
```
    The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request. The option is a: java.lang.String type. Group: producer
  - awsKMSKeyId
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder awsKMSKeyId(String awsKMSKeyId)
```
    Define the id of KMS key to use in case KMS is enabled. The option is a: java.lang.String type. Group: producer (advanced)
  - customerAlgorithm
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder customerAlgorithm(String customerAlgorithm)
```
    Define the customer algorithm to use in case CustomerKey is enabled. The option is a: java.lang.String type. Group: producer (advanced)
  - customerKeyId
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder customerKeyId(String customerKeyId)
```
    Define the id of Customer key to use in case CustomerKey is enabled. The option is a: java.lang.String type. Group: producer (advanced)
  - customerKeyMD5
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder customerKeyMD5(String customerKeyMD5)
```
    Define the MD5 of Customer key to use in case CustomerKey is enabled. The option is a: java.lang.String type. Group: producer (advanced)
  - useAwsKMS
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder useAwsKMS(boolean useAwsKMS)
```
    Define if KMS must be used or not. The option is a: boolean type. Default: false Group: producer (advanced)
  - useCustomerKey
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder useCustomerKey(boolean useCustomerKey)
```
    Define if Customer Key must be used or not. The option is a: boolean type. Default: false Group: producer (advanced)
  - basicPropertyBinding
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - accessKey
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder accessKey(String accessKey)
```
    Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
  - secretKey
```
default Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder secretKey(String secretKey)
```
    Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security

Interface Aws2S3ComponentBuilderFactory.Aws2S3ComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

amazonS3Client

autoCreateBucket

configuration

overrideEndpoint

pojoRequest

policy

proxyHost

proxyPort

proxyProtocol

region

uriEndpointOverride

useIAMCredentials

bridgeErrorHandler

deleteAfterRead

delimiter

destinationBucket

fileName

includeBody

includeFolders

moveAfterRead

prefix

autocloseBody

deleteAfterWrite

keyName

lazyStartProducer

multiPartUpload

operation

partSize

storageClass

awsKMSKeyId

customerAlgorithm

customerKeyId

customerKeyMD5

useAwsKMS

useCustomerKey

basicPropertyBinding

accessKey

secretKey