amazonka-kms-2.0: Amazon Key Management Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.KMS.DeleteCustomKeyStore

Description

Deletes a custom key store. This operation does not affect any backing elements of the custom key store. It does not delete the CloudHSM cluster that is associated with an CloudHSM key store, or affect any users or keys in the cluster. For an external key store, it does not affect the external key store proxy, external key manager, or any external keys.

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.

The custom key store that you delete cannot contain any KMS keys. Before deleting the key store, verify that you will never need to use any of the KMS keys in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the KMS keys from the key store. After the required waiting period expires and all KMS keys are deleted from the custom key store, use DisconnectCustomKeyStore to disconnect the key store from KMS. Then, you can delete the custom key store.

For keys in an CloudHSM key store, the ScheduleKeyDeletion operation makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. KMS never creates, manages, or deletes cryptographic keys in the external key manager associated with an external key store. You must manage them using your external key manager tools.

Instead of deleting the custom key store, consider using the DisconnectCustomKeyStore operation to disconnect the custom key store from its backing key store. While the key store is disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to delete KMS keys and you can reconnect a disconnected custom key store at any time.

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:DeleteCustomKeyStore (IAM policy)

Related operations:

  • ConnectCustomKeyStore
  • CreateCustomKeyStore
  • DescribeCustomKeyStores
  • DisconnectCustomKeyStore
  • UpdateCustomKeyStore
Synopsis

Creating a Request

data DeleteCustomKeyStore Source #

See: newDeleteCustomKeyStore smart constructor.

Constructors

DeleteCustomKeyStore' 

Fields

  • customKeyStoreId :: Text

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

Instances

Instances details
ToJSON DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

ToHeaders DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

ToPath DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

ToQuery DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

AWSRequest DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

Associated Types

type AWSResponse DeleteCustomKeyStore #

Generic DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

Associated Types

type Rep DeleteCustomKeyStore :: Type -> Type #

Read DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

Show DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

NFData DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

Methods

rnf :: DeleteCustomKeyStore -> () #

Eq DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

Hashable DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

type AWSResponse DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

type Rep DeleteCustomKeyStore Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

type Rep DeleteCustomKeyStore = D1 ('MetaData "DeleteCustomKeyStore" "Amazonka.KMS.DeleteCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DeleteCustomKeyStore'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customKeyStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteCustomKeyStore Source #

Create a value of DeleteCustomKeyStore 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:

DeleteCustomKeyStore, deleteCustomKeyStore_customKeyStoreId - Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Request Lenses

deleteCustomKeyStore_customKeyStoreId :: Lens' DeleteCustomKeyStore Text Source #

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

Destructuring the Response

data DeleteCustomKeyStoreResponse Source #

See: newDeleteCustomKeyStoreResponse smart constructor.

Constructors

DeleteCustomKeyStoreResponse' 

Fields

Instances

Instances details
Generic DeleteCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

Associated Types

type Rep DeleteCustomKeyStoreResponse :: Type -> Type #

Read DeleteCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

Show DeleteCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

NFData DeleteCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

Eq DeleteCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

type Rep DeleteCustomKeyStoreResponse Source # 
Instance details

Defined in Amazonka.KMS.DeleteCustomKeyStore

type Rep DeleteCustomKeyStoreResponse = D1 ('MetaData "DeleteCustomKeyStoreResponse" "Amazonka.KMS.DeleteCustomKeyStore" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "DeleteCustomKeyStoreResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteCustomKeyStoreResponse Source #

Create a value of DeleteCustomKeyStoreResponse 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:DeleteCustomKeyStoreResponse', deleteCustomKeyStoreResponse_httpStatus - The response's http status code.

Response Lenses