Chapter 8. AWS SNS Sink

Send message to an AWS SNS Topic

8.1. Configuration Options

The following table summarizes the configuration options available for the aws-sns-sink Kamelet:

PropertyNameDescriptionTypeDefaultExample

accessKey *

Access Key

The access key obtained from AWS

string

  

region *

AWS Region

The AWS region to connect to

string

 

"eu-west-1"

secretKey *

Secret Key

The secret key obtained from AWS

string

  

topicNameOrArn *

Topic Name

The SQS Topic name or ARN

string

  

autoCreateTopic

Autocreate Topic

Setting the autocreation of the SNS topic.

boolean

false

 
Note

Fields marked with an asterisk (*) are mandatory.

8.2. Dependencies

At runtime, the aws-sns-sink Kamelet relies upon the presence of the following dependencies:

  • camel:kamelet
  • camel:aws2-sns

8.3. Usage

This section describes how you can use the aws-sns-sink.

8.3.1. Knative Sink

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

aws-sns-sink-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-sns-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-sns-sink
    properties:
      accessKey: "The Access Key"
      region: "eu-west-1"
      secretKey: "The Secret Key"
      topicNameOrArn: "The Topic Name"

8.3.1.1. Prerequisite

Make sure you have "Red Hat Integration - Camel K" installed into the OpenShift cluster you’re connected to.

8.3.1.2. Procedure for using the cluster CLI

  1. Save the aws-sns-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.
  2. Run the sink by using the following command:

    oc apply -f aws-sns-sink-binding.yaml

8.3.1.3. Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind channel:mychannel aws-sns-sink -p "sink.accessKey=The Access Key" -p "sink.region=eu-west-1" -p "sink.secretKey=The Secret Key" -p "sink.topicNameOrArn=The Topic Name"

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

8.3.2. Kafka Sink

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

aws-sns-sink-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-sns-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-sns-sink
    properties:
      accessKey: "The Access Key"
      region: "eu-west-1"
      secretKey: "The Secret Key"
      topicNameOrArn: "The Topic Name"

8.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.

8.3.2.2. Procedure for using the cluster CLI

  1. Save the aws-sns-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.
  2. Run the sink by using the following command:

    oc apply -f aws-sns-sink-binding.yaml

8.3.2.3. Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic aws-sns-sink -p "sink.accessKey=The Access Key" -p "sink.region=eu-west-1" -p "sink.secretKey=The Secret Key" -p "sink.topicNameOrArn=The Topic Name"

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

8.4. Kamelet source file

https://github.com/openshift-integration/kamelet-catalog/tree/kamelet-catalog-1.8//aws-sns-sink.kamelet.yaml