libZSservicesZSamazonka-kmsZSamazonka-kms
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.KMS.DisconnectCustomKeyStore

Description

Disconnects the custom key store from its associated CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its KMS keys, but you cannot create or use KMS keys 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 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.

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 KMS, which combines the convenience and extensive integration of 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 Amazon Web Services account.

Required permissions: kms:DisconnectCustomKeyStore (IAM policy)

Related operations:

  • ConnectCustomKeyStore
  • CreateCustomKeyStore
  • DeleteCustomKeyStore
  • DescribeCustomKeyStores
  • UpdateCustomKeyStore
Synopsis

Creating a Request

data DisconnectCustomKeyStore Source #

See: newDisconnectCustomKeyStore smart constructor.

Constructors

DisconnectCustomKeyStore' 

Fields

  • customKeyStoreId :: Text

    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.

Instances

Instances details
Eq DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Read DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Show DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Generic DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Associated Types

type Rep DisconnectCustomKeyStore :: Type -> Type #

NFData DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Hashable DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

ToJSON DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

AWSRequest DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

ToHeaders DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

ToPath DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

ToQuery DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

type Rep DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

type Rep DisconnectCustomKeyStore = D1 ('MetaData "DisconnectCustomKeyStore" "Amazonka.KMS.DisconnectCustomKeyStore" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "DisconnectCustomKeyStore'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DisconnectCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

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:

$sel:customKeyStoreId: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.

Constructors

DisconnectCustomKeyStoreResponse' 

Fields

Instances

Instances details
Eq DisconnectCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Read DisconnectCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Show DisconnectCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Generic DisconnectCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

Associated Types

type Rep DisconnectCustomKeyStoreResponse :: Type -> Type #

NFData DisconnectCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

type Rep DisconnectCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DisconnectCustomKeyStore

type Rep DisconnectCustomKeyStoreResponse = D1 ('MetaData "DisconnectCustomKeyStoreResponse" "Amazonka.KMS.DisconnectCustomKeyStore" "libZSservicesZSamazonka-kmsZSamazonka-kms" '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