Skip to content

Commit

Permalink
Kamelets Catalog - Make the description a one liner - AWS Kinesis Sink
Browse files Browse the repository at this point in the history
Signed-off-by: Andrea Cosentino <[email protected]>
  • Loading branch information
oscerd committed Jan 14, 2025
1 parent 11c9426 commit f5e75b9
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/modules/ROOT/partials/aws-kinesis-sink-description.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
== AWS Kinesis 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-partition` property to set the Kinesis partition key.

If you do not set the property in the header, the Kamelet uses the exchange ID for the partition key.

You can also set the `sequence-number` / `ce-sequencenumber` property in the header to specify the Sequence number.

0 comments on commit f5e75b9

Please sign in to comment.