Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account

Migrate your Key Storage Provider (KSP) from AWS CloudHSM Client SDK 3 to Client SDK 5

PDF
RSS
Focus mode
Migrate your Key Storage Provider (KSP) from AWS CloudHSM Client SDK 3 to Client SDK 5 - AWS CloudHSM
Migrate to Client SDK 5Related topics

Use this topic to migrate your Key Storage Provider (KSP) from AWS CloudHSM Client SDK 3 to Client SDK 5. For benefits on migrating, see Benefits of AWS CloudHSM Client SDK 5.

In AWS CloudHSM, customer applications perform cryptographic operations using the AWS CloudHSM Client Software Development Kit (SDK). Client SDK 5 is the primary SDK that continues to have new features and platform support added to it.

To review migration instructions for all providers, see Migrating from AWS CloudHSM Client SDK 3 to Client SDK 5.

Migrate to Client SDK 5

Follow the instructions in this section to migrate from Client SDK 3 to Client SDK 5.

  1. Uninstall the Client Daemon for Client SDK 3.

    Windows Server 2016
    $ Get-WmiObject -Class Win32_Product | Where-Object {$_.Name -eq "AWS CloudHSM Client"} | ForEach-Object {$_.Uninstall()}
    Windows Server 2019
    $ Get-WmiObject -Class Win32_Product | Where-Object {$_.Name -eq "AWS CloudHSM Client"} | ForEach-Object {$_.Uninstall()}
    Windows Server 2022
    $ Get-WmiObject -Class Win32_Product | Where-Object {$_.Name -eq "AWS CloudHSM Client"} | ForEach-Object {$_.Uninstall()}
    anchoranchoranchor
    $ Get-WmiObject -Class Win32_Product | Where-Object {$_.Name -eq "AWS CloudHSM Client"} | ForEach-Object {$_.Uninstall()}

  2. Install the Client SDK Key Storage Provider (KSP) by following the steps in Install the Key storage provider (KSP) for AWS CloudHSM Client SDK 5.

  3. Client SDK 5 introduces a new configuration file format and command-line bootstrapping tool. To bootstrap your Client SDK 5 Key Storage Provider (KSP), follow the instructions listed in the user guide under Bootstrap the Client SDK.

  4. Key Storage Provider (KSP) for AWS CloudHSM Client SDK 5 introduces a SDK3 compatibility mode option to support the usage of key file for SDK3. See SDK3 compatibility mode for Key Storage Provider (KSP) for AWS CloudHSM.

  5. In your development environment, test your application. Make updates to your existing code to resolve your breaking changes before your final migration.

Related topics

On this page

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.