Skip to content

KMS  >  Operations  >  disconnect_custom_key_store

disconnect_custom_key_store

Operation

disconnect_custom_key_store async

disconnect_custom_key_store(request: DisconnectCustomKeyStoreInput | DisconnectCustomKeyStoreInputDict, /, *, plugins: list[Plugin] | None = None) -> DisconnectCustomKeyStoreOutput
disconnect_custom_key_store(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DisconnectCustomKeyStoreInputDict]) -> DisconnectCustomKeyStoreOutput

Disconnects the custom key store from its backing key store. This operation disconnects an CloudHSM key store from its associated CloudHSM cluster or disconnects an external key store from the external key store proxy that communicates with your external key manager.

This operation is part of the custom key stores feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a key store that you own and manage.

While a custom key store is disconnected, you can manage the custom key store and its KMS keys, but you cannot create or use its KMS keys. You can reconnect the custom key store at any time.

Note

While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.

When you disconnect a custom key store, its ConnectionState changes to Disconnected. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.

If the operation succeeds, it returns a JSON object with no properties.

Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

Required permissions: kms:DisconnectCustomKeyStore (IAM policy)

Related operations:

  • ConnectCustomKeyStore

  • CreateCustomKeyStore

  • DeleteCustomKeyStore

  • DescribeCustomKeyStores

  • UpdateCustomKeyStore

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DisconnectCustomKeyStoreOutput

An instance of DisconnectCustomKeyStoreOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DisconnectCustomKeyStoreInput dataclass

Bases: _SerdeShape

Dataclass for DisconnectCustomKeyStoreInput structure.

Attributes
custom_key_store_id class-attribute instance-attribute
custom_key_store_id: str | None = ...

Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Dictionaries

DisconnectCustomKeyStoreInputDict

Bases: TypedDict

Dictionary form of DisconnectCustomKeyStoreInput.

Attributes
custom_key_store_id instance-attribute
custom_key_store_id: Required[str]

Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Output

DisconnectCustomKeyStoreOutput dataclass

Bases: _SerdeShape

Dataclass for DisconnectCustomKeyStoreOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.