UpdateSecret Method

Updates a secret's information.

Syntax

ANSI (Cross Platform)
int UpdateSecret(const char* lpszSecretId, const char* lpszDescription);

Unicode (Windows)
INT UpdateSecret(LPCWSTR lpszSecretId, LPCWSTR lpszDescription);
- (void)updateSecret:(NSString*)secretId :(NSString*)description;
#define MID_AMAZONSECRETS_UPDATESECRET 19

CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_AmazonSecrets_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

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