Changes the properties of a custom key store. Use the CustomKeyStoreId
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
disconnect_custom_key_store. To
reconnect the custom key store after the update completes, use
connect_custom_key_store. To find the
connection state of a custom key store, use the
describe_custom_key_stores
operation.
Use the parameters of
update_custom_key_store 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.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:UpdateCustomKeyStore (IAM policy)
Related operations:
connect_custom_key_store
create_custom_key_store
delete_custom_key_store
describe_custom_key_stores
disconnect_custom_key_store
kms_update_custom_key_store(CustomKeyStoreId, NewCustomKeyStoreName,
KeyStorePassword, CloudHsmClusterId)An empty list.
[required] Identifies the custom key store that you want to update. Enter the ID of
the custom key store. To find the ID of a custom key store, use the
describe_custom_key_stores
operation.
Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.
Enter the current password of the kmsuser crypto user (CU) in the AWS
CloudHSM cluster that is associated with the custom key store.
This parameter tells AWS KMS the current password of the kmsuser
crypto user (CU). It does not set or change the password of any users in
the AWS CloudHSM cluster.
Associates the custom key store with a related AWS CloudHSM cluster.
Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.
svc$update_custom_key_store(
CustomKeyStoreId = "string",
NewCustomKeyStoreName = "string",
KeyStorePassword = "string",
CloudHsmClusterId = "string"
)