| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.KMS.ScheduleKeyDeletion
Description
Schedules the deletion of a KMS key. By default, KMS applies a waiting
period of 30 days, but you can specify a waiting period of 7-30 days.
When this operation is successful, the key state of the KMS key changes
to PendingDeletion and the key can't be used in any cryptographic
operations. It remains in this state for the duration of the waiting
period. Before the waiting period ends, you can use CancelKeyDeletion to
cancel the deletion of the KMS key. After the waiting period ends, KMS
deletes the KMS key, its key material, and all KMS data associated with
it, including all aliases that refer to it.
Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is a multi-Region replica key.) To prevent the use of a KMS key without deleting it, use DisableKey.
If you schedule deletion of a KMS key from a
custom key store,
when the waiting period expires, ScheduleKeyDeletion deletes the KMS
key from KMS. Then KMS makes a best effort to delete the key material
from the associated CloudHSM cluster. However, you might need to
manually
delete the orphaned key material
from the cluster and its backups.
You can schedule the deletion of a multi-Region primary key and its
replica keys at any time. However, KMS will not delete a multi-Region
primary key with existing replica keys. If you schedule the deletion of
a primary key with replicas, its key state changes to
PendingReplicaDeletion and it cannot be replicated or used in
cryptographic operations. This status can continue indefinitely. When
the last of its replicas keys is deleted (not just scheduled), the key
state of the primary key changes to PendingDeletion and its waiting
period (PendingWindowInDays) begins. For details, see
Deleting multi-Region keys
in the Key Management Service Developer Guide.
For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the Key Management Service Developer Guide.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:ScheduleKeyDeletion (key policy)
Related operations
- CancelKeyDeletion
- DisableKey
Synopsis
- data ScheduleKeyDeletion = ScheduleKeyDeletion' {}
- newScheduleKeyDeletion :: Text -> ScheduleKeyDeletion
- scheduleKeyDeletion_pendingWindowInDays :: Lens' ScheduleKeyDeletion (Maybe Natural)
- scheduleKeyDeletion_keyId :: Lens' ScheduleKeyDeletion Text
- data ScheduleKeyDeletionResponse = ScheduleKeyDeletionResponse' {}
- newScheduleKeyDeletionResponse :: Int -> ScheduleKeyDeletionResponse
- scheduleKeyDeletionResponse_keyId :: Lens' ScheduleKeyDeletionResponse (Maybe Text)
- scheduleKeyDeletionResponse_keyState :: Lens' ScheduleKeyDeletionResponse (Maybe KeyState)
- scheduleKeyDeletionResponse_deletionDate :: Lens' ScheduleKeyDeletionResponse (Maybe UTCTime)
- scheduleKeyDeletionResponse_pendingWindowInDays :: Lens' ScheduleKeyDeletionResponse (Maybe Natural)
- scheduleKeyDeletionResponse_httpStatus :: Lens' ScheduleKeyDeletionResponse Int
Creating a Request
data ScheduleKeyDeletion Source #
See: newScheduleKeyDeletion smart constructor.
Constructors
| ScheduleKeyDeletion' | |
Fields
| |
Instances
newScheduleKeyDeletion Source #
Arguments
| :: Text | |
| -> ScheduleKeyDeletion |
Create a value of ScheduleKeyDeletion 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:pendingWindowInDays:ScheduleKeyDeletion', scheduleKeyDeletion_pendingWindowInDays - The waiting period, specified in number of days. After the waiting
period ends, KMS deletes the KMS key.
If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.
This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
$sel:keyId:ScheduleKeyDeletion', scheduleKeyDeletion_keyId - The unique identifier of the KMS key to delete.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab - Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Request Lenses
scheduleKeyDeletion_pendingWindowInDays :: Lens' ScheduleKeyDeletion (Maybe Natural) Source #
The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.
If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.
This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
scheduleKeyDeletion_keyId :: Lens' ScheduleKeyDeletion Text Source #
The unique identifier of the KMS key to delete.
Specify the key ID or key ARN of the KMS key.
For example:
- Key ID:
1234abcd-12ab-34cd-56ef-1234567890ab - Key ARN:
arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Destructuring the Response
data ScheduleKeyDeletionResponse Source #
See: newScheduleKeyDeletionResponse smart constructor.
Constructors
| ScheduleKeyDeletionResponse' | |
Fields
| |
Instances
newScheduleKeyDeletionResponse Source #
Create a value of ScheduleKeyDeletionResponse 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:keyId:ScheduleKeyDeletion', scheduleKeyDeletionResponse_keyId - The Amazon Resource Name
(key ARN)
of the KMS key whose deletion is scheduled.
$sel:keyState:ScheduleKeyDeletionResponse', scheduleKeyDeletionResponse_keyState - The current status of the KMS key.
For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.
$sel:deletionDate:ScheduleKeyDeletionResponse', scheduleKeyDeletionResponse_deletionDate - The date and time after which KMS deletes the KMS key.
If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.
$sel:pendingWindowInDays:ScheduleKeyDeletion', scheduleKeyDeletionResponse_pendingWindowInDays - The waiting period before the KMS key is deleted.
If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.
$sel:httpStatus:ScheduleKeyDeletionResponse', scheduleKeyDeletionResponse_httpStatus - The response's http status code.
Response Lenses
scheduleKeyDeletionResponse_keyId :: Lens' ScheduleKeyDeletionResponse (Maybe Text) Source #
The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.
scheduleKeyDeletionResponse_keyState :: Lens' ScheduleKeyDeletionResponse (Maybe KeyState) Source #
The current status of the KMS key.
For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.
scheduleKeyDeletionResponse_deletionDate :: Lens' ScheduleKeyDeletionResponse (Maybe UTCTime) Source #
The date and time after which KMS deletes the KMS key.
If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.
scheduleKeyDeletionResponse_pendingWindowInDays :: Lens' ScheduleKeyDeletionResponse (Maybe Natural) Source #
The waiting period before the KMS key is deleted.
If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.
scheduleKeyDeletionResponse_httpStatus :: Lens' ScheduleKeyDeletionResponse Int Source #
The response's http status code.