amazonka-kms-1.4.5: Amazon Key Management Service SDK.

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

Network.AWS.KMS.ScheduleKeyDeletion

Contents

Description

Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to PendingDeletion . Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it.

Important: Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey .

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide .

Synopsis

Creating a Request

scheduleKeyDeletion #

Creates a value of ScheduleKeyDeletion with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • skdPendingWindowInDays - The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK). 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.
  • skdKeyId - The unique identifier for the customer master key (CMK) to delete. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey .

data ScheduleKeyDeletion #

See: scheduleKeyDeletion smart constructor.

Instances

Eq ScheduleKeyDeletion # 
Data ScheduleKeyDeletion # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ScheduleKeyDeletion -> c ScheduleKeyDeletion #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ScheduleKeyDeletion #

toConstr :: ScheduleKeyDeletion -> Constr #

dataTypeOf :: ScheduleKeyDeletion -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ScheduleKeyDeletion) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ScheduleKeyDeletion) #

gmapT :: (forall b. Data b => b -> b) -> ScheduleKeyDeletion -> ScheduleKeyDeletion #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ScheduleKeyDeletion -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ScheduleKeyDeletion -> r #

gmapQ :: (forall d. Data d => d -> u) -> ScheduleKeyDeletion -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ScheduleKeyDeletion -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ScheduleKeyDeletion -> m ScheduleKeyDeletion #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ScheduleKeyDeletion -> m ScheduleKeyDeletion #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ScheduleKeyDeletion -> m ScheduleKeyDeletion #

Read ScheduleKeyDeletion # 
Show ScheduleKeyDeletion # 
Generic ScheduleKeyDeletion # 
Hashable ScheduleKeyDeletion # 
ToJSON ScheduleKeyDeletion # 
NFData ScheduleKeyDeletion # 

Methods

rnf :: ScheduleKeyDeletion -> () #

AWSRequest ScheduleKeyDeletion # 
ToQuery ScheduleKeyDeletion # 
ToPath ScheduleKeyDeletion # 
ToHeaders ScheduleKeyDeletion # 
type Rep ScheduleKeyDeletion # 
type Rep ScheduleKeyDeletion = D1 (MetaData "ScheduleKeyDeletion" "Network.AWS.KMS.ScheduleKeyDeletion" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" False) (C1 (MetaCons "ScheduleKeyDeletion'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_skdPendingWindowInDays") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_skdKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs ScheduleKeyDeletion # 

Request Lenses

skdPendingWindowInDays :: Lens' ScheduleKeyDeletion (Maybe Natural) #

The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK). 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.

skdKeyId :: Lens' ScheduleKeyDeletion Text #

The unique identifier for the customer master key (CMK) to delete. To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: * Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey .

Destructuring the Response

scheduleKeyDeletionResponse #

Creates a value of ScheduleKeyDeletionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • skdrsKeyId - The unique identifier of the customer master key (CMK) for which deletion is scheduled.
  • skdrsDeletionDate - The date and time after which AWS KMS deletes the customer master key (CMK).
  • skdrsResponseStatus - -- | The response status code.

data ScheduleKeyDeletionResponse #

See: scheduleKeyDeletionResponse smart constructor.

Instances

Eq ScheduleKeyDeletionResponse # 
Data ScheduleKeyDeletionResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ScheduleKeyDeletionResponse -> c ScheduleKeyDeletionResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ScheduleKeyDeletionResponse #

toConstr :: ScheduleKeyDeletionResponse -> Constr #

dataTypeOf :: ScheduleKeyDeletionResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ScheduleKeyDeletionResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ScheduleKeyDeletionResponse) #

gmapT :: (forall b. Data b => b -> b) -> ScheduleKeyDeletionResponse -> ScheduleKeyDeletionResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ScheduleKeyDeletionResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ScheduleKeyDeletionResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ScheduleKeyDeletionResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ScheduleKeyDeletionResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ScheduleKeyDeletionResponse -> m ScheduleKeyDeletionResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ScheduleKeyDeletionResponse -> m ScheduleKeyDeletionResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ScheduleKeyDeletionResponse -> m ScheduleKeyDeletionResponse #

Read ScheduleKeyDeletionResponse # 
Show ScheduleKeyDeletionResponse # 
Generic ScheduleKeyDeletionResponse # 
NFData ScheduleKeyDeletionResponse # 
type Rep ScheduleKeyDeletionResponse # 
type Rep ScheduleKeyDeletionResponse = D1 (MetaData "ScheduleKeyDeletionResponse" "Network.AWS.KMS.ScheduleKeyDeletion" "amazonka-kms-1.4.5-5KQpvh5Ruw27D0B5DkiMna" False) (C1 (MetaCons "ScheduleKeyDeletionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_skdrsKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_skdrsDeletionDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_skdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

skdrsKeyId :: Lens' ScheduleKeyDeletionResponse (Maybe Text) #

The unique identifier of the customer master key (CMK) for which deletion is scheduled.

skdrsDeletionDate :: Lens' ScheduleKeyDeletionResponse (Maybe UTCTime) #

The date and time after which AWS KMS deletes the customer master key (CMK).