Add AWS IAM SASL mechanism for authenticating against AWS MSK (#193)

* Add AWS IAM SASL mechanism for authenticating against AWS MSK * Add new SASL mechanism to JS API docs * Update JS API docs * Add comment to example script * Clarify comment
mostafa · Feb 21, 2023 · fc71c8b · fc71c8b
1 parent 793ffd4
commit fc71c8b
Show file tree

Hide file tree

Showing 37 changed files with 225 additions and 166 deletions.
diff --git a/api-docs/docs/classes/Connection.md b/api-docs/docs/classes/Connection.md
@@ -44,7 +44,7 @@ connection.close();
 
 #### Defined in
 
-[index.d.ts:371](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L371)
+[index.d.ts:372](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L372)
 
 ## Methods
 
@@ -64,7 +64,7 @@ connection.close();
 
 #### Defined in
 
-[index.d.ts:397](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L397)
+[index.d.ts:398](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L398)
 
 ---
 
@@ -89,7 +89,7 @@ Create a new topic.
 
 #### Defined in
 
-[index.d.ts:378](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L378)
+[index.d.ts:379](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L379)
 
 ---
 
@@ -114,7 +114,7 @@ Delete a topic.
 
 #### Defined in
 
-[index.d.ts:385](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L385)
+[index.d.ts:386](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L386)
 
 ---
 
@@ -133,4 +133,4 @@ List topics.
 
 #### Defined in
 
-[index.d.ts:391](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L391)
+[index.d.ts:392](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L392)
diff --git a/api-docs/docs/classes/Reader.md b/api-docs/docs/classes/Reader.md
@@ -43,7 +43,7 @@ reader.close();
 
 #### Defined in
 
-[index.d.ts:330](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L330)
+[index.d.ts:331](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L331)
 
 ## Methods
 
@@ -63,7 +63,7 @@ reader.close();
 
 #### Defined in
 
-[index.d.ts:343](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L343)
+[index.d.ts:344](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L344)
 
 ---
 
@@ -88,4 +88,4 @@ Read messages from Kafka.
 
 #### Defined in
 
-[index.d.ts:337](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L337)
+[index.d.ts:338](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L338)
diff --git a/api-docs/docs/classes/SchemaRegistry.md b/api-docs/docs/classes/SchemaRegistry.md
@@ -79,7 +79,7 @@ writer.produce({
 
 #### Defined in
 
-[index.d.ts:459](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L459)
+[index.d.ts:460](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L460)
 
 ## Methods
 
@@ -104,7 +104,7 @@ Create or update a schema on Schema Registry.
 
 #### Defined in
 
-[index.d.ts:473](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L473)
+[index.d.ts:474](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L474)
 
 ---
 
@@ -129,7 +129,7 @@ Deserializes the given data and schema into its original form.
 
 #### Defined in
 
-[index.d.ts:494](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L494)
+[index.d.ts:495](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L495)
 
 ---
 
@@ -154,7 +154,7 @@ Get a schema from Schema Registry by version and subject.
 
 #### Defined in
 
-[index.d.ts:466](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L466)
+[index.d.ts:467](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L467)
 
 ---
 
@@ -179,7 +179,7 @@ Returns the subject name for the given SubjectNameConfig.
 
 #### Defined in
 
-[index.d.ts:480](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L480)
+[index.d.ts:481](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L481)
 
 ---
 
@@ -204,4 +204,4 @@ Serializes the given data and schema into a byte array.
 
 #### Defined in
 
-[index.d.ts:487](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L487)
+[index.d.ts:488](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L488)
diff --git a/api-docs/docs/classes/Writer.md b/api-docs/docs/classes/Writer.md
@@ -51,7 +51,7 @@ writer.close();
 
 #### Defined in
 
-[index.d.ts:288](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L288)
+[index.d.ts:289](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L289)
 
 ## Methods
 
@@ -71,7 +71,7 @@ writer.close();
 
 #### Defined in
 
-[index.d.ts:301](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L301)
+[index.d.ts:302](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L302)
 
 ---
 
@@ -96,4 +96,4 @@ Write messages to Kafka.
 
 #### Defined in
 
-[index.d.ts:295](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L295)
+[index.d.ts:296](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L296)
diff --git a/api-docs/docs/enums/BALANCERS.md b/api-docs/docs/enums/BALANCERS.md
@@ -18,7 +18,7 @@
 
 #### Defined in
 
-[index.d.ts:69](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L69)
+[index.d.ts:70](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L70)
 
 ---
 
@@ -28,7 +28,7 @@
 
 #### Defined in
 
-[index.d.ts:68](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L68)
+[index.d.ts:69](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L69)
 
 ---
 
@@ -38,7 +38,7 @@
 
 #### Defined in
 
-[index.d.ts:67](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L67)
+[index.d.ts:68](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L68)
 
 ---
 
@@ -48,7 +48,7 @@
 
 #### Defined in
 
-[index.d.ts:70](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L70)
+[index.d.ts:71](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L71)
 
 ---
 
@@ -58,4 +58,4 @@
 
 #### Defined in
 
-[index.d.ts:66](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L66)
+[index.d.ts:67](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L67)
diff --git a/api-docs/docs/enums/ELEMENT_TYPES.md b/api-docs/docs/enums/ELEMENT_TYPES.md
@@ -15,7 +15,7 @@
 
 #### Defined in
 
-[index.d.ts:41](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L41)
+[index.d.ts:42](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L42)
 
 ---
 
@@ -25,4 +25,4 @@
 
 #### Defined in
 
-[index.d.ts:42](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L42)
+[index.d.ts:43](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L43)
diff --git a/api-docs/docs/enums/GROUP_BALANCERS.md b/api-docs/docs/enums/GROUP_BALANCERS.md
@@ -16,7 +16,7 @@
 
 #### Defined in
 
-[index.d.ts:77](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L77)
+[index.d.ts:78](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L78)
 
 ---
 
@@ -26,7 +26,7 @@
 
 #### Defined in
 
-[index.d.ts:75](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L75)
+[index.d.ts:76](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L76)
 
 ---
 
@@ -36,4 +36,4 @@
 
 #### Defined in
 
-[index.d.ts:76](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L76)
+[index.d.ts:77](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L77)
diff --git a/api-docs/docs/enums/ISOLATION_LEVEL.md b/api-docs/docs/enums/ISOLATION_LEVEL.md
@@ -15,7 +15,7 @@
 
 #### Defined in
 
-[index.d.ts:48](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L48)
+[index.d.ts:49](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L49)
 
 ---
 
@@ -25,4 +25,4 @@
 
 #### Defined in
 
-[index.d.ts:47](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L47)
+[index.d.ts:48](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L48)
diff --git a/api-docs/docs/enums/SASL_MECHANISMS.md b/api-docs/docs/enums/SASL_MECHANISMS.md
@@ -5,6 +5,7 @@
 ### Enumeration Members
 
 - [NONE](SASL_MECHANISMS.md#none)
+- [SASL_AWS_IAM](SASL_MECHANISMS.md#sasl_aws_iam)
 - [SASL_PLAIN](SASL_MECHANISMS.md#sasl_plain)
 - [SASL_SCRAM_SHA256](SASL_MECHANISMS.md#sasl_scram_sha256)
 - [SASL_SCRAM_SHA512](SASL_MECHANISMS.md#sasl_scram_sha512)
@@ -22,6 +23,16 @@
 
 ---
 
+### SASL_AWS_IAM
+
+• **SASL_AWS_IAM**
+
+#### Defined in
+
+[index.d.ts:29](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L29)
+
+---
+
 ### SASL_PLAIN
 
 • **SASL_PLAIN**

diff --git a/api-docs/docs/enums/SCHEMA_TYPES.md b/api-docs/docs/enums/SCHEMA_TYPES.md
@@ -18,7 +18,7 @@
 
 #### Defined in
 
-[index.d.ts:84](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L84)
+[index.d.ts:85](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L85)
 
 ---
 
@@ -28,7 +28,7 @@
 
 #### Defined in
 
-[index.d.ts:83](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L83)
+[index.d.ts:84](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L84)
 
 ---
 
@@ -38,7 +38,7 @@
 
 #### Defined in
 
-[index.d.ts:85](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L85)
+[index.d.ts:86](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L86)
 
 ---
 
@@ -48,7 +48,7 @@
 
 #### Defined in
 
-[index.d.ts:86](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L86)
+[index.d.ts:87](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L87)
 
 ---
 
@@ -58,4 +58,4 @@
 
 #### Defined in
 
-[index.d.ts:82](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L82)
+[index.d.ts:83](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L83)
diff --git a/api-docs/docs/enums/START_OFFSETS.md b/api-docs/docs/enums/START_OFFSETS.md
@@ -15,7 +15,7 @@
 
 #### Defined in
 
-[index.d.ts:54](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L54)
+[index.d.ts:55](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L55)
 
 ---
 
@@ -25,4 +25,4 @@
 
 #### Defined in
 
-[index.d.ts:53](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L53)
+[index.d.ts:54](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L54)
diff --git a/api-docs/docs/enums/SUBJECT_NAME_STRATEGY.md b/api-docs/docs/enums/SUBJECT_NAME_STRATEGY.md
@@ -16,7 +16,7 @@
 
 #### Defined in
 
-[index.d.ts:60](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L60)
+[index.d.ts:61](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L61)
 
 ---
 
@@ -26,7 +26,7 @@
 
 #### Defined in
 
-[index.d.ts:59](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L59)
+[index.d.ts:60](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L60)
 
 ---
 
@@ -36,4 +36,4 @@
 
 #### Defined in
 
-[index.d.ts:61](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L61)
+[index.d.ts:62](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L62)
diff --git a/api-docs/docs/enums/TIME.md b/api-docs/docs/enums/TIME.md
@@ -19,7 +19,7 @@
 
 #### Defined in
 
-[index.d.ts:96](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L96)
+[index.d.ts:97](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L97)
 
 ---
 
@@ -29,7 +29,7 @@
 
 #### Defined in
 
-[index.d.ts:92](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L92)
+[index.d.ts:93](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L93)
 
 ---
 
@@ -39,7 +39,7 @@
 
 #### Defined in
 
-[index.d.ts:93](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L93)
+[index.d.ts:94](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L94)
 
 ---
 
@@ -49,7 +49,7 @@
 
 #### Defined in
 
-[index.d.ts:95](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L95)
+[index.d.ts:96](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L96)
 
 ---
 
@@ -59,7 +59,7 @@
 
 #### Defined in
 
-[index.d.ts:91](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L91)
+[index.d.ts:92](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L92)
 
 ---
 
@@ -69,4 +69,4 @@
 
 #### Defined in
 
-[index.d.ts:94](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L94)
+[index.d.ts:95](https://github.com/mostafa/xk6-kafka/blob/main/api-docs/index.d.ts#L95)