Skip to content

Commit

Permalink
Kamelets Catalog - Make the description a one liner - AWS CloudWatch …
Browse files Browse the repository at this point in the history
…Sink

Signed-off-by: Andrea Cosentino <ancosen@gmail.com>
  • Loading branch information
oscerd committed Jan 13, 2025
1 parent 56ff4aa commit 6030eb8
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/modules/ROOT/partials/aws-cloudwatch-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
== AWS Cloudwatch 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]

=== Metric Headers

In this Kamelet you could use the following headers for metrics:

- `metric-name` / `ce-metricname` for the metric name.
- `metric-value` / `ce-metricvalue` for the metric value.
- `metric-unit` / `ce-metricunit` for the metric unit.
- `metric-timestamp` / `ce-metrictimestamp` for the metric timestamp.
- `metric-dimension-name` / `ce-metricdimensionname` for the dimension name.
- `metric-dimension-value` / `ce-metricdimensionvalue` for the dimension value.

0 comments on commit 6030eb8

Please sign in to comment.