luciano/amazon-kinesis-client
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

revise wording on updating aws credentials

Browse source
This commit is contained in:
Vincent Viloria 2025-03-11 18:00:54 -07:00
parent 4dbbdf9f8e
commit 5dd65d1c44
2 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -48,9 +48,16 @@ To make it easier for developers to write record processors in other languages,
## Using the KCL ## Using the KCL
The recommended way to use the KCL for Java is to consume it from Maven. The recommended way to use the KCL for Java is to consume it from Maven.
## Must read if you are migrating to a version using KCL 2.7 or later ## 🚨Important: Migration to KCL 2.7 or later with MultiLangDaemon - Credential Provider Changes Required
KCL version 2.7.0 and beyond does not use the AWS SDK v1. Because of this, all multilang users upgrading from a prior version must update their multilang `.properties` AwsCredentialsProvider property to an AWS SDK v2 credential provider name. Please see the credentials provider name mapping [here](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-client-credentials.html#credentials-changes-mapping), and reference our Configuring Credential Providers documentation [here](https://github.com/vincentvilo-aws/amazon-kinesis-client/blob/remove-sdk-v1/docs/multilang/configuring-credential-providers.md). If this is not done, your multilang KCL will fail to construct an AwsCredentialsProvider on startup. KCL version 2.7.0 and later uses AWS SDK for Java 2.x instead of AWS SDK for Java 1.x. All MultiLangDaemon users
upgrading from earlier versions must update their credential provider configuration in the `.properties` file to use
credentials provider name for AWS SDK for Java 2.x. Failure to do this will cause your multilang KCL application to fail
during startup with credential provider construction errors. Please check the following link for the credentials
provider mapping and MultiLangDaemon credentials provider configuration guide.
- [AWS SDK for Java 1.x to 2.x Credentials Provider Mapping](aws.amazon.com/sdk-for-java/latest/developer-guide/migration-client-credentials.html#credentials-changes-mapping)
- [KCL Multilang Credentials Provider Configuration Guide](https://github.com/aws/amazon-kinesis-client/blob/master/docs/multilang/configuring-credential-providers.md)
### Version 2.x ### Version 2.x
``` xml ``` xml
<dependency> <dependency>

7
docs/multilang/configuring-credential-providers.md
View file

@ -6,9 +6,10 @@ KCL multilang does not, and is not intended to, proxy the full breadth of the AW
However, KCL now provides better extensibility to handle, and be enhanced to handle, additional configurations. However, KCL now provides better extensibility to handle, and be enhanced to handle, additional configurations.
This document should help multilang customers configure a suitable `CredentialProvider` (or contribute changes to support a new use case!). This document should help multilang customers configure a suitable `CredentialProvider` (or contribute changes to support a new use case!).
In KCL versions prior to 2.7, the AWSCredentialsProvider property expected AWS SDK v1 provider names. If you are using In KCL versions prior to 2.7, the `AWSCredentialsProvider` property used AWS SDK for Java 1.x provider names.
KCL version 2.7 or beyond, ensure that you are passing an AWS SDK v2 credentials provider name to your AwsCredentialsProvider When upgrading to KCL 2.7 or later, you must update to use AWS SDK v2 credentials provider names in your configuration.
property. See list of providers [here](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-client-credentials.html#credentials-changes-mapping) and several examples below. For a complete mapping of credential provider names between version 1.x and 2.x, see the [AWS SDK for Java migration guide — Credentials provider changes mapped between versions 1.x and 2.x](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/migration-client-credentials.html#credentials-changes-mapping).
You also can refer to the following examples.
## Sample Provider Configuration ## Sample Provider Configuration