Chapter 10. AWS SQS Source
Receive data from AWS SQS.
10.1. Configuration Options
The following table summarizes the configuration options available for the aws-sqs-source Kamelet:
| Property | Name | Description | Type | Default | Example |
|---|---|---|---|---|---|
| accessKey * | Access Key | The access key obtained from AWS | string | ||
| queueNameOrArn * | Queue Name | The SQS Queue name or ARN | string | ||
| region * | AWS Region | The AWS region to connect to | string |
| |
| secretKey * | Secret Key | The secret key obtained from AWS | string | ||
| autoCreateQueue | Autocreate Queue | Setting the autocreation of the SQS queue. | boolean |
| |
| deleteAfterRead | Auto-delete Messages | Delete messages after consuming them | boolean |
|
Fields marked with an asterisk (*) are mandatory.
10.2. Dependencies
At runtime, the aws-sqs-source Kamelet relies upon the presence of the following dependencies:
- camel:aws2-sqs
- camel:core
- camel:kamelet
- camel:jackson
10.3. Usage
This section describes how you can use the aws-sqs-source.
10.3.1. Knative Source
You can use the aws-sqs-source Kamelet as a Knative source by binding it to a Knative object.
aws-sqs-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: aws-sqs-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: aws-sqs-source
properties:
accessKey: "The Access Key"
queueNameOrArn: "The Queue Name"
region: "eu-west-1"
secretKey: "The Secret Key"
sink:
ref:
kind: Channel
apiVersion: messaging.knative.dev/v1
name: mychannel
10.3.1.1. Prerequisite
Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.
10.3.1.2. Procedure for using the cluster CLI
-
Save the
aws-sqs-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-sqs-source-binding.yaml
10.3.1.3. Procedure for using the Kamel CLI
Configure and run the source by using the following command:
kamel bind aws-sqs-source -p "source.accessKey=The Access Key" -p "source.queueNameOrArn=The Queue 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.
10.3.2. Kafka Source
You can use the aws-sqs-source Kamelet as a Kafka source by binding it to a Kafka topic.
aws-sqs-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: aws-sqs-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: aws-sqs-source
properties:
accessKey: "The Access Key"
queueNameOrArn: "The Queue Name"
region: "eu-west-1"
secretKey: "The Secret Key"
sink:
ref:
kind: KafkaTopic
apiVersion: kafka.strimzi.io/v1beta1
name: my-topic
10.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.
10.3.2.2. Procedure for using the cluster CLI
-
Save the
aws-sqs-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-sqs-source-binding.yaml
10.3.2.3. Procedure for using the Kamel CLI
Configure and run the source by using the following command:
kamel bind aws-sqs-source -p "source.accessKey=The Access Key" -p "source.queueNameOrArn=The Queue 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.
10.4. Kamelet source file
https://github.com/openshift-integration/kamelet-catalog/aws-sqs-source.kamelet.yaml
