disconnectCustomKeyStore method

Future<void> disconnectCustomKeyStore({
  1. required String customKeyStoreId,
})

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.

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.

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:

May throw CustomKeyStoreInvalidStateException. May throw CustomKeyStoreNotFoundException. May throw KMSInternalException.

Parameter customKeyStoreId : 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.

Implementation

Future<void> disconnectCustomKeyStore({
  required String customKeyStoreId,
}) async {
  ArgumentError.checkNotNull(customKeyStoreId, 'customKeyStoreId');
  _s.validateStringLength(
    'customKeyStoreId',
    customKeyStoreId,
    1,
    64,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'TrentService.DisconnectCustomKeyStore'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'CustomKeyStoreId': customKeyStoreId,
    },
  );
}