blob: c5fb178ba3abaede886ceec781c5088b9e426fc6 [file] [log] [blame]
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
= image:kamelets/aws-sns-fifo-sink.svg[] AWS SNS FIFO Sink
*Provided by: "Apache Software Foundation"*
Send message to an AWS SNS FIFO Topic
== Configuration Options
The following table summarizes the configuration options available for the `aws-sns-fifo-sink` Kamelet:
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *accessKey {empty}* *| Access Key| The access key obtained from AWS| string| |
| *region {empty}* *| AWS Region| The AWS region to connect to| string| | `"eu-west-1"`
| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS| string| |
| *topicNameOrArn {empty}* *| Topic Name| The SNS Topic name or ARN| string| |
| autoCreateTopic| Autocreate Topic| Setting the autocreation of the SNS topic.| boolean| `false`|
| contentBasedDeduplication| Content-Based Deduplication| Use content-based deduplication (should be enabled in the SQS FIFO queue first)| boolean| `false`|
|===
NOTE: Fields marked with ({empty}*) are mandatory.
== Usage
This section summarizes how the `aws-sns-fifo-sink` can be used in various contexts.
=== Knative Sink
The `aws-sns-fifo-sink` Kamelet can be used as Knative sink by binding it to a Knative object.
.aws-sns-fifo-sink-binding.yaml
[source,yaml]
----
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: aws-sns-fifo-sink-binding
spec:
source:
ref:
kind: InMemoryChannel
apiVersion: messaging.knative.dev/v1
name: mychannel
sink:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: aws-sns-fifo-sink
properties:
accessKey: "The Access Key"
region: "eu-west-1"
secretKey: "The Secret Key"
topicNameOrArn: "The Topic Name"
----
Make sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.
Save the `aws-sns-fifo-sink-binding.yaml` file into your hard drive, then configure it according to your needs.
You can run the sink using the following command:
[source,shell]
----
kubectl apply -f aws-sns-fifo-sink-binding.yaml
----
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT