This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
The following commit(s) were added to refs/heads/main by this push:
new 2f8de712 Kamelets Catalog - Make the description a one liner - AWS S3
Streaming Upload Sink (#2359)
2f8de712 is described below
commit 2f8de7127fd59a5e0b50d5a3d50b2e7f385149ec
Author: Andrea Cosentino <anco...@gmail.com>
AuthorDate: Thu Jan 16 12:34:27 2025 +0100
Kamelets Catalog - Make the description a one liner - AWS S3 Streaming
Upload Sink (#2359)
Signed-off-by: Andrea Cosentino <anco...@gmail.com>
---
.../aws-s3-streaming-upload-sink-description.adoc | 26 ++++++++++++++++++++++
kamelets/aws-s3-streaming-upload-sink.kamelet.yaml | 7 +-----
.../aws-s3-streaming-upload-sink.kamelet.yaml | 7 +-----
3 files changed, 28 insertions(+), 12 deletions(-)
diff --git
a/docs/modules/ROOT/partials/aws-s3-streaming-upload-sink-description.adoc
b/docs/modules/ROOT/partials/aws-s3-streaming-upload-sink-description.adoc
new file mode 100644
index 00000000..dee86f3d
--- /dev/null
+++ b/docs/modules/ROOT/partials/aws-s3-streaming-upload-sink-description.adoc
@@ -0,0 +1,26 @@
+== AWS S3 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]
+
+=== Optional Headers
+
+In the header, you can optionally set the `file` / `ce-file` property to
specify the name of the file to upload.
+
+If you do not set the property in the header, the Kamelet uses the exchange ID
for the file name.
diff --git a/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml
b/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml
index d835b557..2a3a6d68 100644
--- a/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml
+++ b/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml
@@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: "AWS S3 Streaming upload Sink"
- description: |-
- Upload data to AWS S3 in streaming upload mode.
-
- Access Key/Secret Key are the basic method for authenticating to the AWS
S3 Service. These parameters are optional because the Kamelet provides the
'useDefaultCredentialsProvider'.
-
- When using a default Credentials Provider the S3 client will load the
credentials through this provider and won't use the static credential. This is
reason for not having the access key and secret key as mandatory parameter for
this Kamelet.
+ description: Upload data to AWS S3 in streaming upload mode.
required:
- bucketNameOrArn
- region
diff --git
a/library/camel-kamelets/src/main/resources/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml
b/library/camel-kamelets/src/main/resources/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml
index d835b557..2a3a6d68 100644
---
a/library/camel-kamelets/src/main/resources/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml
+++
b/library/camel-kamelets/src/main/resources/kamelets/aws-s3-streaming-upload-sink.kamelet.yaml
@@ -31,12 +31,7 @@ metadata:
spec:
definition:
title: "AWS S3 Streaming upload Sink"
- description: |-
- Upload data to AWS S3 in streaming upload mode.
-
- Access Key/Secret Key are the basic method for authenticating to the AWS
S3 Service. These parameters are optional because the Kamelet provides the
'useDefaultCredentialsProvider'.
-
- When using a default Credentials Provider the S3 client will load the
credentials through this provider and won't use the static credential. This is
reason for not having the access key and secret key as mandatory parameter for
this Kamelet.
+ description: Upload data to AWS S3 in streaming upload mode.
required:
- bucketNameOrArn
- region
