AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.aws.s3.S3Component>

All Known Implementing Classes:

AwsS3ComponentBuilderFactory.AwsS3ComponentBuilderImpl

Enclosing interface:

AwsS3ComponentBuilderFactory
```
public static interface AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder
extends ComponentBuilder<org.apache.camel.component.aws.s3.S3Component>
```
Builder for the AWS S3 Storage Service component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`accelerateModeEnabled(boolean accelerateModeEnabled)` Define if Accelerate Mode enabled is true or false.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`accessKey(String accessKey)` Amazon AWS Access Key.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`amazonS3Client(com.amazonaws.services.s3.AmazonS3 amazonS3Client)` Reference to a com.amazonaws.services.s3.AmazonS3 in the registry.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`autocloseBody(boolean autocloseBody)` If this option is true and includeBody is true, then the S3Object.close() method will be called on exchange completion.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`autoCreateBucket(boolean autoCreateBucket)` Setting the autocreation of the bucket.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`awsKMSKeyId(String awsKMSKeyId)` Define the id of KMS key to use in case KMS is enabled.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`chunkedEncodingDisabled(boolean chunkedEncodingDisabled)` Define if disabled Chunked Encoding is true or false.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`configuration(org.apache.camel.component.aws.s3.S3Configuration configuration)` The component configuration.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`deleteAfterRead(boolean deleteAfterRead)` Delete objects from S3 after they have been retrieved.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`deleteAfterWrite(boolean deleteAfterWrite)` Delete file object after the S3 file has been uploaded.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`dualstackEnabled(boolean dualstackEnabled)` Define if Dualstack enabled is true or false.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`encryptionMaterials(com.amazonaws.services.s3.model.EncryptionMaterials encryptionMaterials)` The encryption materials to use in case of Symmetric/Asymmetric client usage.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`endpointConfiguration(com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration endpointConfiguration)` Amazon AWS Endpoint Configuration.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`fileName(String fileName)` To get the object from the bucket with the given file name.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`forceGlobalBucketAccessEnabled(boolean forceGlobalBucketAccessEnabled)` Define if Force Global Bucket Access enabled is true or false.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`includeBody(boolean includeBody)` If it is true, the exchange body will be set to a stream to the contents of the file.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`keyName(String keyName)` Setting the key name for an element in the bucket through endpoint parameter.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`operation(org.apache.camel.component.aws.s3.S3Operations operation)` The operation to do in case the user don't want to do only an upload.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`partSize(long partSize)` Setup the partSize which is used in multi part upload, the default size is 25M.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`pathStyleAccess(boolean pathStyleAccess)` Whether or not the S3 client should use path style access.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`payloadSigningEnabled(boolean payloadSigningEnabled)` Define if Payload Signing enabled is true or false.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`policy(String policy)` The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3#setBucketPolicy() method.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`proxyHost(String proxyHost)` To define a proxy host when instantiating the S3 client.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`proxyPort(Integer proxyPort)` Specify a proxy port to be used inside the client definition.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`proxyProtocol(com.amazonaws.Protocol proxyProtocol)` To define a proxy protocol when instantiating the S3 client.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`region(String region)` The region in which S3 client needs to work.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`secretKey(String secretKey)` Amazon AWS Secret Key.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`serverSideEncryption(String serverSideEncryption)` Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`storageClass(String storageClass)` The storage class to set in the com.amazonaws.services.s3.model.PutObjectRequest request.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`useAwsKMS(boolean useAwsKMS)` Define if KMS must be used or not.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`useEncryption(boolean useEncryption)` Define if encryption must be used or not.
`default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder`	`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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder amazonS3Client(com.amazonaws.services.s3.AmazonS3 amazonS3Client)
```
    Reference to a com.amazonaws.services.s3.AmazonS3 in the registry. The option is a: com.amazonaws.services.s3.AmazonS3 type. Group: common
  - autoCreateBucket
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder autoCreateBucket(boolean autoCreateBucket)
```
    Setting the autocreation of the bucket. The option is a: boolean type. Default: true Group: common
  - configuration
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder configuration(org.apache.camel.component.aws.s3.S3Configuration configuration)
```
    The component configuration. The option is a: org.apache.camel.component.aws.s3.S3Configuration type. Group: common
  - endpointConfiguration
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder endpointConfiguration(com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration endpointConfiguration)
```
    Amazon AWS Endpoint Configuration. The option is a: com.amazonaws.client.builder.AwsClientBuilder.EndpointConfiguration type. Group: common
  - pathStyleAccess
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder pathStyleAccess(boolean pathStyleAccess)
```
    Whether or not the S3 client should use path style access. The option is a: boolean type. Default: false Group: common
  - policy
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder proxyHost(String proxyHost)
```
    To define a proxy host when instantiating the S3 client. The option is a: java.lang.String type. Group: common
  - proxyPort
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder proxyProtocol(com.amazonaws.Protocol proxyProtocol)
```
    To define a proxy protocol when instantiating the S3 client. The option is a: com.amazonaws.Protocol type. Default: HTTPS Group: common
  - region
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder region(String 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(). The option is a: java.lang.String type. Group: common
  - useIAMCredentials
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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
  - encryptionMaterials
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder encryptionMaterials(com.amazonaws.services.s3.model.EncryptionMaterials encryptionMaterials)
```
    The encryption materials to use in case of Symmetric/Asymmetric client usage. The option is a: com.amazonaws.services.s3.model.EncryptionMaterials type. Group: common (advanced)
  - useEncryption
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder useEncryption(boolean useEncryption)
```
    Define if encryption must be used or not. The option is a: boolean type. Default: false Group: common (advanced)
  - bridgeErrorHandler
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 S3Constants#BUCKET_NAME and S3Constants#KEY headers, or only the S3Constants#KEY header. The option is a: boolean type. Default: true Group: consumer
  - delimiter
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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
  - fileName
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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
  - prefix
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder operation(org.apache.camel.component.aws.s3.S3Operations 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.aws.s3.S3Operations type. Group: producer
  - partSize
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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
  - serverSideEncryption
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder serverSideEncryption(String serverSideEncryption)
```
    Sets the server-side encryption algorithm when encrypting the object using AWS-managed keys. For example use AES256. The option is a: java.lang.String type. Group: producer
  - storageClass
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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)
  - useAwsKMS
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder useAwsKMS(boolean useAwsKMS)
```
    Define if KMS must be used or not. The option is a: boolean type. Default: false Group: producer (advanced)
  - accelerateModeEnabled
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder accelerateModeEnabled(boolean accelerateModeEnabled)
```
    Define if Accelerate Mode enabled is true or false. The option is a: boolean type. Default: false Group: advanced
  - chunkedEncodingDisabled
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder chunkedEncodingDisabled(boolean chunkedEncodingDisabled)
```
    Define if disabled Chunked Encoding is true or false. The option is a: boolean type. Default: false Group: advanced
  - dualstackEnabled
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder dualstackEnabled(boolean dualstackEnabled)
```
    Define if Dualstack enabled is true or false. The option is a: boolean type. Default: false Group: advanced
  - forceGlobalBucketAccessEnabled
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder forceGlobalBucketAccessEnabled(boolean forceGlobalBucketAccessEnabled)
```
    Define if Force Global Bucket Access enabled is true or false. The option is a: boolean type. Default: false Group: advanced
  - payloadSigningEnabled
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder payloadSigningEnabled(boolean payloadSigningEnabled)
```
    Define if Payload Signing enabled is true or false. The option is a: boolean type. Default: false Group: advanced
  - basicPropertyBinding
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder 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 AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder accessKey(String accessKey)
```
    Amazon AWS Access Key. The option is a: java.lang.String type. Group: security
  - secretKey
```
default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder secretKey(String secretKey)
```
    Amazon AWS Secret Key. The option is a: java.lang.String type. Group: security

Interface AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder

Method Summary

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

Method Detail

amazonS3Client

autoCreateBucket

configuration

endpointConfiguration

pathStyleAccess

policy

proxyHost

proxyPort

proxyProtocol

region

useIAMCredentials

encryptionMaterials

useEncryption

bridgeErrorHandler

deleteAfterRead

delimiter

fileName

includeBody

prefix

autocloseBody

deleteAfterWrite

keyName

lazyStartProducer

multiPartUpload

operation

partSize

serverSideEncryption

storageClass

awsKMSKeyId

useAwsKMS

accelerateModeEnabled

chunkedEncodingDisabled

dualstackEnabled

forceGlobalBucketAccessEnabled

payloadSigningEnabled

basicPropertyBinding

accessKey

secretKey