KeyDeletionDate Property

The date at which the CMK will be deleted, if applicable.

Syntax

 amazonkms.getKeyDeletionDate(index, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getKeyDeletionDate([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setKeyDeletionDate([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The date at which the CMK will be deleted, if applicable.

If the CMK's KeyState is aksPendingDeletion (2), this property will reflect the deletion date, in seconds since the Unix epoch (including fractional seconds).

The index parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

String