Changes the properties of a custom key store. Use the
parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.
You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore
. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore
. To find the connection state of a custom key store, use the DescribeCustomKeyStores
Use the parameters of
to edit your keystore settings.
- Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify.
- Use the KeyStorePassword parameter tell AWS KMS the current password of the
kmsuser crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to fix connection failures that occur when AWS KMS cannot log into the associated cluster because the
kmsuser password has changed. This value does not change the password in the AWS CloudHSM cluster.
- Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature
feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.