Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
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
Synopsis
- data DisconnectCustomKeyStore = DisconnectCustomKeyStore' {}
- newDisconnectCustomKeyStore :: Text -> DisconnectCustomKeyStore
- disconnectCustomKeyStore_customKeyStoreId :: Lens' DisconnectCustomKeyStore Text
- data DisconnectCustomKeyStoreResponse = DisconnectCustomKeyStoreResponse' {
- httpStatus :: Int
- newDisconnectCustomKeyStoreResponse :: Int -> DisconnectCustomKeyStoreResponse
- disconnectCustomKeyStoreResponse_httpStatus :: Lens' DisconnectCustomKeyStoreResponse Int
Creating a Request
data DisconnectCustomKeyStore Source #
See: newDisconnectCustomKeyStore
smart constructor.
DisconnectCustomKeyStore' | |
|
Instances
newDisconnectCustomKeyStore Source #
Create a value of DisconnectCustomKeyStore
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisconnectCustomKeyStore
, disconnectCustomKeyStore_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.
Request Lenses
disconnectCustomKeyStore_customKeyStoreId :: Lens' DisconnectCustomKeyStore Text Source #
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.
Destructuring the Response
data DisconnectCustomKeyStoreResponse Source #
See: newDisconnectCustomKeyStoreResponse
smart constructor.
DisconnectCustomKeyStoreResponse' | |
|
Instances
Generic DisconnectCustomKeyStoreResponse Source # | |
Read DisconnectCustomKeyStoreResponse Source # | |
Show DisconnectCustomKeyStoreResponse Source # | |
Defined in Amazonka.KMS.DisconnectCustomKeyStore | |
NFData DisconnectCustomKeyStoreResponse Source # | |
Defined in Amazonka.KMS.DisconnectCustomKeyStore rnf :: DisconnectCustomKeyStoreResponse -> () # | |
Eq DisconnectCustomKeyStoreResponse Source # | |
type Rep DisconnectCustomKeyStoreResponse Source # | |
Defined in Amazonka.KMS.DisconnectCustomKeyStore type Rep DisconnectCustomKeyStoreResponse = D1 ('MetaData "DisconnectCustomKeyStoreResponse" "Amazonka.KMS.DisconnectCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DisconnectCustomKeyStoreResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDisconnectCustomKeyStoreResponse Source #
Create a value of DisconnectCustomKeyStoreResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisconnectCustomKeyStoreResponse'
, disconnectCustomKeyStoreResponse_httpStatus
- The response's http status code.
Response Lenses
disconnectCustomKeyStoreResponse_httpStatus :: Lens' DisconnectCustomKeyStoreResponse Int Source #
The response's http status code.