Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.
While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.
To find the connection state of a custom key store, use the
describe_custom_key_stores
operation. To reconnect a custom key store, use the
connect_custom_key_store operation.
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:DisconnectCustomKeyStore (IAM policy)
Related operations:
connect_custom_key_store
create_custom_key_store
delete_custom_key_store
describe_custom_key_stores
update_custom_key_store
kms_disconnect_custom_key_store(CustomKeyStoreId)An empty list.
[required] Enter the ID of the custom key store you want to disconnect. To find the
ID of a custom key store, use the
describe_custom_key_stores
operation.
svc$disconnect_custom_key_store(
CustomKeyStoreId = "string"
)