kms_disconnect_custom_key_store: Disconnects the custom key store from its associated AWS...

Description Usage Arguments Details Request syntax

View source: R/kms_operations.R

Description

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.

Usage

1

Arguments

CustomKeyStoreId

[required] 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.

Details

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 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.

Request syntax

1
2
3
svc$disconnect_custom_key_store(
  CustomKeyStoreId = "string"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.