From 246d30f6e7ddf9a1a2e5e68355942d5662e3eeca Mon Sep 17 00:00:00 2001 From: Andrea Cosentino Date: Mon, 13 Jan 2025 14:56:30 +0100 Subject: [PATCH] Kamelets Catalog - Make the description a one liner - AWS Kinesis Firehose Sink Signed-off-by: Andrea Cosentino --- ...aws-kinesis-firehose-sink-description.adoc | 20 +++++++++++++++++++ .../aws-kinesis-firehose-sink.kamelet.yaml | 7 +------ .../aws-kinesis-firehose-sink.kamelet.yaml | 7 +------ 3 files changed, 22 insertions(+), 12 deletions(-) create mode 100644 docs/modules/ROOT/partials/aws-kinesis-firehose-sink-description.adoc diff --git a/docs/modules/ROOT/partials/aws-kinesis-firehose-sink-description.adoc b/docs/modules/ROOT/partials/aws-kinesis-firehose-sink-description.adoc new file mode 100644 index 000000000..714c8919e --- /dev/null +++ b/docs/modules/ROOT/partials/aws-kinesis-firehose-sink-description.adoc @@ -0,0 +1,20 @@ +== AWS Kinesis Firehose 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] diff --git a/kamelets/aws-kinesis-firehose-sink.kamelet.yaml b/kamelets/aws-kinesis-firehose-sink.kamelet.yaml index ec5e6b839..0865a3452 100644 --- a/kamelets/aws-kinesis-firehose-sink.kamelet.yaml +++ b/kamelets/aws-kinesis-firehose-sink.kamelet.yaml @@ -31,12 +31,7 @@ metadata: spec: definition: title: AWS Kinesis Firehose Sink - description: |- - Send message to an AWS Kinesis Firehose Stream - - Access Key/Secret Key are the basic method for authenticating to the AWS Kinesis Firehose Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. - - When using a default Credentials Provider the Kinesis Firehose 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: Send message to an AWS Kinesis Firehose Stream. required: - streamName - region diff --git a/library/camel-kamelets/src/main/resources/kamelets/aws-kinesis-firehose-sink.kamelet.yaml b/library/camel-kamelets/src/main/resources/kamelets/aws-kinesis-firehose-sink.kamelet.yaml index ec5e6b839..0865a3452 100644 --- a/library/camel-kamelets/src/main/resources/kamelets/aws-kinesis-firehose-sink.kamelet.yaml +++ b/library/camel-kamelets/src/main/resources/kamelets/aws-kinesis-firehose-sink.kamelet.yaml @@ -31,12 +31,7 @@ metadata: spec: definition: title: AWS Kinesis Firehose Sink - description: |- - Send message to an AWS Kinesis Firehose Stream - - Access Key/Secret Key are the basic method for authenticating to the AWS Kinesis Firehose Service. These parameters are optional because the Kamelet provides the 'useDefaultCredentialsProvider'. - - When using a default Credentials Provider the Kinesis Firehose 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: Send message to an AWS Kinesis Firehose Stream. required: - streamName - region