This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch 2345-2
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
commit 37bc242e95f3836ad338b8a3bf533c3f6ca94a8b
Author: Andrea Cosentino <anco...@gmail.com>
AuthorDate: Mon Jan 13 12:16:34 2025 +0100
Kamelets Catalog - Make the description a one liner - AWS DDB Sink
Signed-off-by: Andrea Cosentino <anco...@gmail.com>
---
.../ROOT/partials/aws-ddb-sink-description.adoc | 39 ++++++++++++++++++++++
kamelets/aws-ddb-sink.kamelet.yaml | 20 +----------
.../resources/kamelets/aws-ddb-sink.kamelet.yaml | 20 +----------
3 files changed, 41 insertions(+), 38 deletions(-)
diff --git a/docs/modules/ROOT/partials/aws-ddb-sink-description.adoc
b/docs/modules/ROOT/partials/aws-ddb-sink-description.adoc
new file mode 100644
index 00000000..c5dd934a
--- /dev/null
+++ b/docs/modules/ROOT/partials/aws-ddb-sink-description.adoc
@@ -0,0 +1,39 @@
+== AWS DynamoDB Sink Kamelet Description
+
+=== Authentication methods
+
+In this Kamelet you have the possibility of avoiding the usage of explicit
static credentials by specifying the useDefaultCredentialsProvider option and
set it to true.
+
+The order of evaluation for Default Credentials Provider is the following:
+
+ - Java system properties - `aws.accessKeyId` and `aws.secretKey`.
+ - Environment variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
+ - Web Identity Token from AWS STS.
+ - The shared credentials and config files.
+ - Amazon ECS container credentials - loaded from the Amazon ECS if the
environment variable `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` is set.
+ - Amazon EC2 Instance profile credentials.
+
+You have also the possibility of using Profile Credentials Provider, by
specifying the useProfileCredentialsProvider option to true and
profileCredentialsName to the profile name.
+
+Only one of access key/secret key or default credentials provider could be used
+
+For more information about this you can look at
https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html[AWS
credentials documentation]
+
+=== Expected Data format for sink
+
+This Kamelet expects a JSON-formatted body and it must include the primary key
values that define the DynamoDB item. The mapping between the JSON fields and
table attribute values is done by key. For example, for '{"username":"oscerd",
"city":"Rome"}' input, the Kamelet inserts or update an item in the specified
AWS DynamoDB table and sets the values for the 'username' and 'city'
attributes.
+
+For PutItem operation the Json body defines all item attributes.
+For DeleteItem operation the Json body defines only the primary key attributes
that identify the item to delete.
+For UpdateItem operation the Json body defines both key attributes to identify
the item to be updated and all item attributes tht get updated on the item.
+
+The given Json body can use "operation", "key" and "item" as top level
properties that will be mapped to respective attribute value maps.
+
+[source,json]
+----
+ {
+ "operation": "PutItem"
+ "key": {},
+ "item": {}
+ }
+----
diff --git a/kamelets/aws-ddb-sink.kamelet.yaml
b/kamelets/aws-ddb-sink.kamelet.yaml
index 0cb5da20..42335de4 100644
--- a/kamelets/aws-ddb-sink.kamelet.yaml
+++ b/kamelets/aws-ddb-sink.kamelet.yaml
@@ -31,25 +31,7 @@ metadata:
spec:
definition:
title: "AWS DynamoDB Sink"
- description: |-
- Send data to Amazon DynamoDB. The sent data inserts, updates, or deletes
an item on the specified AWS DynamoDB table.
-
- The basic authentication method for the AWS DynamoDB service is to
specify an access key and a secret key. These parameters are optional because
the Kamelet provides a default credentials provider.
-
- If you use the default credentials provider, the DynamoDB client loads
the credentials through this provider and doesn't use the basic authentication
method.
-
- This Kamelet expects a JSON-formatted body and it must include the
primary key values that define the DynamoDB item. The mapping between the JSON
fields and table attribute values is done by key. For example, for
'{"username":"oscerd", "city":"Rome"}' input, the Kamelet inserts or update an
item in the specified AWS DynamoDB table and sets the values for the 'username'
and 'city' attributes.
-
- For PutItem operation the Json body defines all item attributes.
- For DeleteItem operation the Json body defines only the primary key
attributes that identify the item to delete.
- For UpdateItem operation the Json body defines both key attributes to
identify the item to be updated and all item attributes tht get updated on the
item.
-
- The given Json body can use "operation", "key" and "item" as top level
properties that will be mapped to respective attribute value maps.
- {
- "operation": "PutItem"
- "key": {},
- "item": {}
- }
+ description: Send data to Amazon DynamoDB. The sent data inserts, updates,
or deletes an item on the specified AWS DynamoDB table.
required:
- table
- region
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/aws-ddb-sink.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/aws-ddb-sink.kamelet.yaml
index 0cb5da20..42335de4 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/aws-ddb-sink.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/aws-ddb-sink.kamelet.yaml
@@ -31,25 +31,7 @@ metadata:
spec:
definition:
title: "AWS DynamoDB Sink"
- description: |-
- Send data to Amazon DynamoDB. The sent data inserts, updates, or deletes
an item on the specified AWS DynamoDB table.
-
- The basic authentication method for the AWS DynamoDB service is to
specify an access key and a secret key. These parameters are optional because
the Kamelet provides a default credentials provider.
-
- If you use the default credentials provider, the DynamoDB client loads
the credentials through this provider and doesn't use the basic authentication
method.
-
- This Kamelet expects a JSON-formatted body and it must include the
primary key values that define the DynamoDB item. The mapping between the JSON
fields and table attribute values is done by key. For example, for
'{"username":"oscerd", "city":"Rome"}' input, the Kamelet inserts or update an
item in the specified AWS DynamoDB table and sets the values for the 'username'
and 'city' attributes.
-
- For PutItem operation the Json body defines all item attributes.
- For DeleteItem operation the Json body defines only the primary key
attributes that identify the item to delete.
- For UpdateItem operation the Json body defines both key attributes to
identify the item to be updated and all item attributes tht get updated on the
item.
-
- The given Json body can use "operation", "key" and "item" as top level
properties that will be mapped to respective attribute value maps.
- {
- "operation": "PutItem"
- "key": {},
- "item": {}
- }
+ description: Send data to Amazon DynamoDB. The sent data inserts, updates,
or deletes an item on the specified AWS DynamoDB table.
required:
- table
- region
