Contact Us 1-800-596-4880

Upgrading and Migrating Amazon Kinesis Data Streams Connector to Version 2.x

Upgrade Anypoint Connector for Amazon Kinesis Data Streams (Amazon Kinesis Data Streams Connector) to version 2.x.

Supported Upgrade Paths

From Version To Version

1.x

2.x

Changes in This Release

  • The kinesis-client library is upgraded to version 3.2.0.

  • The kinesis-producer library is upgraded to version 1.0.6.

  • The aws-sts library is upgraded to version 2.38.3.

  • The aws-sdk library is upgraded to version 2.38.3.

  • The netty-codec-http library is upgraded to version 4.2.7.Final.

  • The netty-codec-http2 library is upgraded to version 4.2.7.Final.

  • The netty-codec library is upgraded to version 4.2.7.Final.

  • The kafka-clients library is upgraded to version 4.1.0.

  • The protobuf-java library is upgraded to version 4.33.0.

  • The commons-lang3 library is upgraded to version 3.19.0.

Requirements

Ensure your system meets the following compatibility requirements before you perform the upgrade:

Application/Service Version

Mule

4.3.0 and later

OpenJDK

8, 11, and 17

Amazon-Kinesis-Client

3.2.0

Amazon-Kinesis-Producer

1.0.6

Upgrade Prerequisites

Before you perform the upgrade, create a backup of your files, data, and configuration in case you need to restore to the previous version.

Upgrade Steps

Follow these steps to perform the upgrade to version 2.x:

  1. In Anypoint Studio, create a Mule project.

  2. In the Mule Palette view, click Search in Exchange.

  3. In Add Dependencies to Project, enter amazon kinesis data streams in the search field.

  4. In Available modules, select Amazon Kinesis Data Streams and click Add.

  5. Click Finish.

  6. Verify that the Amazon Kinesis Data Streams dependency version is 2.x in the pom.xml file in the Mule project.

Studio upgrades the connector automatically.

Post-Upgrade Steps

After you install the latest version of the connector, verify that your error handling is updated to work with the minor changes in error codes in this version of the connector.

Verify the Upgrade

After you install the latest version of the connector, follow these steps to verify the upgrade:

  1. In Studio, verify that there are no errors in the Problems or Console views.

  2. Verify that there are no problems in the project pom.xml file.

  3. Test the connection to verify that the operations work.

Revert the Upgrade

If it is necessary to revert to the previous version of Amazon Kinesis Data Streams, change the mule-amazon-kinesis dependency version in the project’s pom.xml file to the previous version.

You must update the project’s pom.xml file in Anypoint Studio.