Cloud Keys 2020 Node.js Edition

Questions / Feedback?

UpdateSecret Method

Updates a secret's information.


amazonsecrets.updateSecret(secretId, description, [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 this 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:



This method updates the information of the secret specified by SecretId.

The value passed for SecretId must the ARN or name of a secret in the current account and Region.

The Description parameter specifies the secret's new description (which may be empty).

The KMSKeyId configuration setting can also be set before calling this method to change the Amazon KMS CMK (customer master key) used to encrypt the secret. However, if the CMK used to encrypt a secret is changed, it is important that the secret's data be updated at least once using CreateVersion. When a new version is created, the server decrypts the secret using the old CMK and re-encrypts it using the new one. If the old CMK is deleted or disabled before this occurs, the server will no longer be able to decrypt the secret, effectively causing its data to be lost.

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