Red Hat Camel K is deprecated
Red Hat Camel K is deprecated and the End of Life date for this product is June 30, 2025. For help migrating to the current go-to solution, Red Hat build of Apache Camel, see the Migration Guide.Chapter 13. AWS S3 Source
Receive data from AWS S3.
13.1. Configuration Options
The following table summarizes the configuration options available for the aws-s3-source Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
| accessKey * | Access Key | The access key obtained from AWS | string | ||
| bucketNameOrArn * | Bucket Name | The S3 Bucket name or ARN | string | ||
| region * | AWS Region | The AWS region to connect to | string |
| |
| secretKey * | Secret Key | The secret key obtained from AWS | string | ||
| autoCreateBucket | Autocreate Bucket | Setting the autocreation of the S3 bucket bucketName. | boolean |
| |
| deleteAfterRead | Auto-delete Objects | Delete objects after consuming them | boolean |
|
Fields marked with an asterisk (*) are mandatory.
13.2. Dependencies
At runtime, the aws-s3-source Kamelet relies upon the presence of the following dependencies:
- camel:kamelet
- camel:aws2-s3
13.3. Usage
This section describes how you can use the aws-s3-source.
13.3.1. 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:
accessKey: "The Access Key"
bucketNameOrArn: "The Bucket Name"
region: "eu-west-1"
secretKey: "The Secret Key"
sink:
ref:
kind: Channel
apiVersion: messaging.knative.dev/v1
name: mychannel
13.3.1.1. Prerequisite
Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
13.3.1.2. Procedure for using the cluster CLI
-
Save the
aws-s3-source-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the source by using the following command:
oc apply -f aws-s3-source-binding.yaml
13.3.1.3. Procedure for using the Kamel CLI
Configure and run the source by using the following command:
kamel bind aws-s3-source -p "source.accessKey=The Access Key" -p "source.bucketNameOrArn=The Bucket Name" -p "source.region=eu-west-1" -p "source.secretKey=The Secret Key" channel:mychannel
This command creates the KameletBinding in the current namespace on the cluster.
13.3.2. 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:
accessKey: "The Access Key"
bucketNameOrArn: "The Bucket Name"
region: "eu-west-1"
secretKey: "The Secret Key"
sink:
ref:
kind: KafkaTopic
apiVersion: kafka.strimzi.io/v1beta1
name: my-topic
13.3.2.1. Prerequisites
Ensure that you’ve installed the AMQ Streams operator in your OpenShift cluster and created a topic named my-topic in the current namespace. Make also sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
13.3.2.2. Procedure for using the cluster CLI
-
Save the
aws-s3-source-binding.yamlfile to your local drive, and then edit it as needed for your configuration. Run the source by using the following command:
oc apply -f aws-s3-source-binding.yaml
13.3.2.3. Procedure for using the Kamel CLI
Configure and run the source by using the following command:
kamel bind aws-s3-source -p "source.accessKey=The Access Key" -p "source.bucketNameOrArn=The Bucket Name" -p "source.region=eu-west-1" -p "source.secretKey=The Secret Key" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic
This command creates the KameletBinding in the current namespace on the cluster.
13.4. Kamelet source file
https://github.com/openshift-integration/kamelet-catalog/aws-s3-source.kamelet.yaml
