AWS S3 Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Receive data from AWS S3 Bucket.

Access Key/Secret Key are the basic method for authenticating to the AWS S3 Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the S3 client will load the credentials through this provider and won’t use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet.

Configuration Options

The following table summarizes the configuration options available for the aws-s3-source Kamelet:

Property	Name	Description	Type	Default	Example
bucketNameOrArn	Bucket Name	Required The S3 Bucket name or ARN.	string
region	AWS Region	Required The AWS region to connect to.	string		eu-west-1
accessKey	Access Key	The access key obtained from AWS.	string
autoCreateBucket	Autocreate Bucket	Setting the autocreation of the S3 bucket bucketName.	boolean	false
deleteAfterRead	Auto-delete Objects	Delete objects after consuming them.	boolean	true
ignoreBody	Ignore Body	If it is true, the S3 Object Body will be ignored completely, if it is set to false the S3 Object will be put in the body. Setting this to true, will override any behavior defined by includeBody option.	boolean	false
includeBody	Include Body	If it is true, the exchange will be consumed and put into the body and closed. If false the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata.	boolean	true
overrideEndpoint	Endpoint Overwrite	Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting.	boolean	false
prefix	Prefix	The AWS S3 bucket prefix to consider while searching.	string		folder/
secretKey	Secret Key	The secret key obtained from AWS.	string
uriEndpointOverride	Overwrite Endpoint URI	Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option.	string
useDefaultCredentialsProvider	Default Credentials Provider	Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.	boolean	false

Property

Name

Description

Type

Default

Example

bucketNameOrArn

Bucket Name

Required The S3 Bucket name or ARN.

string

region

AWS Region

Required The AWS region to connect to.

string

eu-west-1

accessKey

Access Key

The access key obtained from AWS.

string

autoCreateBucket

Autocreate Bucket

Setting the autocreation of the S3 bucket bucketName.

boolean

false

deleteAfterRead

Auto-delete Objects

Delete objects after consuming them.

boolean

true

ignoreBody

Ignore Body

If it is true, the S3 Object Body will be ignored completely, if it is set to false the S3 Object will be put in the body. Setting this to true, will override any behavior defined by includeBody option.

boolean

false

includeBody

Include Body

If it is true, the exchange will be consumed and put into the body and closed. If false the S3Object stream will be put raw into the body and the headers will be set with the S3 object metadata.

boolean

true

overrideEndpoint

Endpoint Overwrite

Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting.

boolean

false

prefix

Prefix

The AWS S3 bucket prefix to consider while searching.

string

folder/

secretKey

Secret Key

The secret key obtained from AWS.

string

uriEndpointOverride

Overwrite Endpoint URI

Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option.

string

useDefaultCredentialsProvider

Default Credentials Provider

Set whether the S3 client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

boolean

false

Dependencies

At runtime, the aws-s3-source Kamelet relies upon the presence of the following dependencies:

camel:aws2-s3
camel:kamelet

Usage

This section describes how you can use the aws-s3-source.

Knative source

You can use the aws-s3-source Kamelet as a Knative source by binding it to a Knative object.

aws-s3-source-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-s3-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-s3-source
    properties:
      bucketNameOrArn: The Bucket Name
      region: eu-west-1
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

Save the aws-s3-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.
Run the source by using the following command:
```
kubectl apply -f aws-s3-source-binding.yaml
```

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind aws-s3-source -p "source.bucketNameOrArn=The Bucket Name" -p "source.region=eu-west-1" channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

Kafka source

You can use the aws-s3-source Kamelet as a Kafka source by binding it to a Kafka topic.

aws-s3-source-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-s3-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-s3-source
    properties:
      bucketNameOrArn: The Bucket Name
      region: eu-west-1
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

You’ve installed Strimzi.
You’ve created a topic named my-topic in the current namespace.
You have Camel K installed on the cluster.

Procedure for using the cluster CLI

Save the aws-s3-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.
Run the source by using the following command:
```
kubectl apply -f aws-s3-source-binding.yaml
```

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind aws-s3-source -p "source.bucketNameOrArn=The Bucket Name" -p "source.region=eu-west-1" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/aws-s3-source.kamelet.yaml