blob: d90c6b396c0d3def372be2b3630f1a435a0973a7 [file] [log] [blame]
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
= image:kamelets/aws-translate-action.svg[] AWS Translate Action
*Provided by: "Apache Software Foundation"*
*Support Level for this Kamelet is: "Preview"*
Translate a text in a specific language
== Configuration Options
The following table summarizes the configuration options available for the `aws-translate-action` 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| |
| *sourceLanguage {empty}* *| Source Language| The source language of the translating text. Possible values are ARABIC("ar"), CHINESE_SIMPLIFIED("zh"), CHINESE_TRADITIONAL("zh-TW"), CZECH("cs"), DANISH("da"), DUTCH("nl"), ENGLISH("en"), FINNISH("fi"), FRENCH("fr"), GERMAN("de"), HEBREW("he"), HINDI("hi"), INDONESIAN("id"), ITALIAN("it"), JAPANESE("ja"), KOREAN("ko"), MALAY("ms"), NORWEGIAN("no"), PERSIAN("fa"), POLISH("pl"), PORTUGUESE("pt"), RUSSIAN("ru"), SPANISH("es"), SWEDISH("sv") and TURKISH("tr").| string| | `"it"`
| *targetLanguage {empty}* *| Target Language| The target language of the translating text. Possible values are ARABIC("ar"), CHINESE_SIMPLIFIED("zh"), CHINESE_TRADITIONAL("zh-TW"), CZECH("cs"), DANISH("da"), DUTCH("nl"), ENGLISH("en"), FINNISH("fi"), FRENCH("fr"), GERMAN("de"), HEBREW("he"), HINDI("hi"), INDONESIAN("id"), ITALIAN("it"), JAPANESE("ja"), KOREAN("ko"), MALAY("ms"), NORWEGIAN("no"), PERSIAN("fa"), POLISH("pl"), PORTUGUESE("pt"), RUSSIAN("ru"), SPANISH("es"), SWEDISH("sv") and TURKISH("tr").| string| | `"en"`
|===
NOTE: Fields marked with ({empty}*) are mandatory.
== Usage
This section summarizes how the `aws-translate-action` can be used in various contexts.
=== Knative Action
The `aws-translate-action` Kamelet can be used as intermediate step in a Knative binding.
.aws-translate-action-binding.yaml
[source,yaml]
----
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: aws-translate-action-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: timer-source
properties:
message: "Hello"
steps:
- ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: aws-translate-action
properties:
accessKey: "The Access Key"
region: "eu-west-1"
secretKey: "The Secret Key"
sourceLanguage: "it"
targetLanguage: "en"
sink:
ref:
kind: InMemoryChannel
apiVersion: messaging.knative.dev/v1
name: mychannel
----
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-translate-action-binding.yaml` file into your hard drive, then configure it according to your needs.
You can run the action using the following command:
[source,shell]
----
kubectl apply -f aws-translate-action-binding.yaml
----
==== *Dependencies*
The Kamelet needs the following dependencies:
- camel:dns
- camel:kamelet
- camel:aws2-translate
==== *Binding to Knative using the Kamel CLI:*
The procedure described above can be simplified into a single execution of the `kamel bind` command:
[source,shell]
----
kamel bind timer-source?message=Hello --step aws-translate-action -p "step-0.accessKey=The Access Key" -p "step-0.region=eu-west-1" -p "step-0.secretKey=The Secret Key" -p "step-0.sourceLanguage=it" -p "step-0.targetLanguage=en" channel:mychannel
----
This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.
=== Kafka Action
The `aws-translate-action` Kamelet can be used as intermediate step in a Kafka binding.
.aws-translate-action-binding.yaml
[source,yaml]
----
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: aws-translate-action-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: timer-source
properties:
message: "Hello"
steps:
- ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: aws-translate-action
properties:
accessKey: "The Access Key"
region: "eu-west-1"
secretKey: "The Secret Key"
sourceLanguage: "it"
targetLanguage: "en"
sink:
ref:
kind: KafkaTopic
apiVersion: kafka.strimzi.io/v1beta1
name: my-topic
----
Ensure that you've installed https://strimzi.io/[Strimzi] and created a topic named `my-topic` in the current namespace.
Make also sure you have xref:latest@camel-k::installation/installation.adoc[Camel K installed] into the Kubernetes cluster you're connected to.
Save the `aws-translate-action-binding.yaml` file into your hard drive, then configure it according to your needs.
You can run the action using the following command:
[source,shell]
----
kubectl apply -f aws-translate-action-binding.yaml
----
==== *Binding to Kafka using the Kamel CLI:*
The procedure described above can be simplified into a single execution of the `kamel bind` command:
[source,shell]
----
kamel bind timer-source?message=Hello --step aws-translate-action -p "step-0.accessKey=The Access Key" -p "step-0.region=eu-west-1" -p "step-0.secretKey=The Secret Key" -p "step-0.sourceLanguage=it" -p "step-0.targetLanguage=en" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic
----
This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.
==== Kamelet source file
Have a look at the following link:
https://github.com/apache/camel-kamelets/blob/main/aws-translate-action.kamelet.yaml
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT