Interface AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder

    • 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
      • autoDiscoverClient

        default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder autoDiscoverClient​(boolean autoDiscoverClient)
        Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. 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
      • 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)
      • 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
      • 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)
      • 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
      • 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
      • 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
      • 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
      • autowiredEnabled

        default AwsS3ComponentBuilderFactory.AwsS3ComponentBuilder autowiredEnabled​(boolean autowiredEnabled)
        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. The option is a: boolean type. Default: true Group: advanced