Add option to set AWS profile in SASL config #338
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There was a problem hiding this comment.
PR Overview
This PR adds a new parameter, awsProfile, to the SASLConfig interface to allow users to specify a custom AWS profile for SASL authentication with AWS IAM, addressing issue #337. In addition, the documentation has been updated throughout the repo to include the new parameter and to adjust various API doc index references.
Reviewed Changes
| File | Description |
|---|---|
| README.md | Added a new FAQ entry describing the use of awsProfile and the AWS_PROFILE environment var |
| api-docs/docs/interfaces/SASLConfig.md | Introduced awsProfile in the interface listing with documentation details |
| Other api-docs/documents (ConnectionConfig.md, Connection.md, etc.) | Updated index.d.ts reference links to reflect revised line numbers |
Copilot reviewed 27 out of 27 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (3)
api-docs/docs/interfaces/SASLConfig.md:8
- [nitpick] Consider updating the anchor link to match the camelCase property name exactly (e.g. '#awsProfile') for consistency with the code.
+- [awsProfile](SASLConfig.md#awsprofile)
README.md:532
- [nitpick] To enhance clarity, consider specifying which setting takes precedence if both AWS_PROFILE and the awsProfile option are provided.
+ You can use the `AWS_PROFILE` environment variable to specify the profile name or use the `awsProfile` option in the `SASLConfig` [object](api-docs/docs/interfaces/SASLConfig.md).
api-docs/docs/interfaces/ConnectionConfig.md:19
- [nitpick] Verify that the updated index.d.ts line reference accurately reflects the current definition location to avoid broken documentation links.
+[index.d.ts:218](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L218)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a parameter to SASLConfig called
awsProfileto fix #337, which can be used to set a custom AWS profile to authenticate against AWS IAM instead of the default one.