Cloud Keys 2020 Node.js Edition

Questions / Feedback?

KeyExpirationDate Property

The date at which the CMK's key material will expire, if applicable.

Syntax

 amazonkms.getKeyExpirationDate(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 getKeyExpirationDate([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 setKeyExpirationDate([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's key material will expire, if applicable.

If the CMK's key material KeyOrigin is akoExternal (1), and the external key material has an expiration date, this property will reflect said date, in seconds since the Unix epoch (including fractional seconds).

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

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Keys 2020 Node.js Edition - Version 20.0 [Build 7718]