CreateSecret Method

Creates a new secret.

Syntax

ANSI (Cross Platform)
char* CreateSecret(const char* lpszSecretName, const char* lpszDescription);

Unicode (Windows)
LPWSTR CreateSecret(LPCWSTR lpszSecretName, LPCWSTR lpszDescription);
- (NSString*)createSecret:(NSString*)secretName :(NSString*)description;
#define MID_AMAZONSECRETS_CREATESECRET 5

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

Remarks

This method creates a new secret with the given SecretName. The secret data is taken from the input stream supplied via the SetInputStream method, the specified LocalFile, or the SecretData or SecretString property; it may be up to 65536 bytes in length. The Id of the initial secret version is returned.

The value passed for SecretName may be up to 512 characters long, and must consist solely of ASCII letters, digits, and the following characters: /_+=.@-.

The Description parameter is optional; it can be any string up to 2048 characters long.

If desired, the KMSKeyId configuration setting can be set before calling this method to specify the Amazon KMS CMK (customer master key) to use to encrypt the secret (by default, an AWS-managed one is used).

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its 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.

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