aws sqs source AWS SQS Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Receive data from AWS SQS.

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

"eu-west-1"

secretKey *

Secret Key

The secret key obtained from AWS

string

amazonAWSHost

AWS Host

The hostname of the Amazon AWS cloud.

string

autoCreateQueue

Autocreate Queue

Setting the autocreation of the SQS queue.

boolean

false

deleteAfterRead

Auto-delete Messages

Delete messages after consuming them

boolean

true

protocol

Protocol

The underlying protocol used to communicate with SQS

string

"https"

"http or https"

Fields marked with an asterisk (*) are mandatory.

Dependencies

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

  • camel:aws2-sqs

  • camel:kamelet

Usage

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

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

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the aws-sqs-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f aws-sqs-source-binding.yaml

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.

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

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

  1. Save the aws-sqs-source-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f aws-sqs-source-binding.yaml

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.