Upgrading from Client SDK 3 to Client SDK 5 requires you to have a source version of PingAccess that you plan to upgrade to or past a target version of PingAccess 7.3 or later.

To upgrade the AWS CloudHSM Client SDK from 3.x to 5.x to integrate it with a target version of PingAccess 7.3 or later:

  1. Ensure that the source version of PingAccess that you plan to upgrade to or past version 7.3 is running.
    Important:

    Do not stop this source version of PingAccess until step 7.

  2. Stop the CloudHSM 3 standalone client with the sudo service cloudhsm-client stop command.
  3. Move or delete the /opt/cloudhsm file.
    Important:

    You can't complete step 4 if you already have the AWS CloudHSM client installed because of the structural changes made to the client between 3.x and 5.x. If you are upgrading from PingAccess 7.2 or earlier, you must remove any existing CloudHSM client software.

  4. Install the JCE 5 client.

    For more information, see Install and use the AWS CloudHSM JCE provider for Client SDK 5 in the AWS CloudHSM documentation.

  5. Copy the cloudhsm-5.x.0.jar file into the pingaccess/deploy directory of the target version of PingAccess that you plan to upgrade to.
  6. Run the PingAccess upgrade.

    For more information, see Upgrading PingAccess.

  7. Stop the source version of PingAccess.

    For more information, see Stopping PingAccess.

You have upgraded to your target version of PingAccess and integrated AWS CloudHSM Client SDK 5 with it.