AmazonSecrets Class

Properties   Methods   Events   Config Settings   Errors  

The AmazonSecrets class provides an easy-to-use interface for Amazon's Secrets Manager service.

Syntax

AmazonSecrets

Remarks

The AmazonSecrets class makes it easy to work with the Amazon Secrets Manager service in a secure manner using TLS. Amazon Secrets Manager allows you to securely store secrets (e.g., passwords, symmetric keys, etc.) in the cloud so that the aren't persisted locally. This class helps you to create, manage, and access those secrets.

To begin, register for an AWS account and obtain an AccessKey and SecretKey to use for authentication.

Resource Terminology

A secret in Amazon Secrets Manager is a container for one or more secret versions, which is where secret data is actually stored. Each secret version can have between zero and 20 staging labels attached to it at any given time.

A staging label is a simple string that can be used instead of a version Id to refer to a particular secret version when retrieving secret data. A staging label can only be attached to one version of a secret at any given time. The server ensures that there is always exactly one version of a secret with the special staging label AWSCURRENT, but otherwise you are free to apply any staging labels to any secret versions you choose.

Secret versions that do not have any staging labels attached to them are considered deprecated, and the server may delete them at any time without warning. Deprecated secret versions are not shown in a secret's version list unless explicitly asked for.

Using the Class

The CreateSecret method will create a new secret with an initial secret version that holds the specified secret data. To change a secret's data, create a new version of it using the CreateVersion method.

To retrieve a secret's data, call the GetSecret method, and specify the specific version (either by Id or using a staging label) whose data should be retrieved. If no particular version is specified, the version with the AWSCURRENT staging label is used.

Secrets that will no longer be used can be deleted using the DeleteSecret method, either immediately or after a waiting period. If a secret is scheduled for deletion later, then during said waiting period the deletion can be canceled using CancelDeletion. // Creates a new secret with the textual data "Test123" named MySecret. // The initial secret version will have only the "AWSCURRENT" staging label. amazonsecrets.SecretString = "Test123"; amazonsecrets.CreateSecret("MySecret", "A description of my secret."); // Creates a new secret version with the textual data "Cats456" and // attaches the staging labels "AWSCURRENT" (which gets moved from the previous version) // and "best-version" to it. amazonsecrets.SecretString = "Cats456"; amazonsecrets.CreateVersion("MySecret", "AWSCURRENT,best-version"); // Downloads the latest secret version's data to a local file. amazonsecrets.LocalFile = "C:\temp\secret.txt"; amazonsecrets.GetSecret("MySecret", "", ""); // Schedules the secret, and all its versions, for deletion after 10 days. amazonsecrets.DeleteSecret("MySecret", 10); // Cancels the scheduled deletion. amazonsecrets.CancelDeletion("MySecret");

To list secrets, use the ListSecrets method. To list a secret's versions, use the ListVersions method. // If there are many secrets to list, there may be multiple pages of results. This will // cause all pages of results to be accumulated into the Secrets collection property. do { amazonsecrets.ListSecrets(); } while (!string.IsNullOrEmpty(amazonsecrets.SecretMarker)); // A similar thing applies to secret versions as well. do { amazonsecrets.ListVersions("MySecret"); } while (!string.IsNullOrEmpty(amazonsecrets.VersionMarker));

The class also supports other functionality, including:

• Adding, removing, and moving staging labels between secret versions using MoveStagingLabel.
• Retrieval of information for a single secret with GetSecretInfo.
• Random password generation using GenRandomPassword.
• And more!

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AccessKey Property (AmazonSecrets Class)

The access key to use for authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccessKey();
int SetAccessKey(const char* lpszAccessKey);

Unicode (Windows)
LPWSTR GetAccessKey();
INT SetAccessKey(LPCWSTR lpszAccessKey);

char* cloudkeys_amazonsecrets_getaccesskey(void* lpObj);
int cloudkeys_amazonsecrets_setaccesskey(void* lpObj, const char* lpszAccessKey);

QString GetAccessKey();
int SetAccessKey(QString qsAccessKey);

Default Value

""

Remarks

This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server.

Data Type

String

FirewallAutoDetect Property (AmazonSecrets Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int cloudkeys_amazonsecrets_getfirewallautodetect(void* lpObj);
int cloudkeys_amazonsecrets_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AmazonSecrets Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int cloudkeys_amazonsecrets_getfirewalltype(void* lpObj);
int cloudkeys_amazonsecrets_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AmazonSecrets Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* cloudkeys_amazonsecrets_getfirewallhost(void* lpObj);
int cloudkeys_amazonsecrets_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (AmazonSecrets Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* cloudkeys_amazonsecrets_getfirewallpassword(void* lpObj);
int cloudkeys_amazonsecrets_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (AmazonSecrets Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int cloudkeys_amazonsecrets_getfirewallport(void* lpObj);
int cloudkeys_amazonsecrets_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (AmazonSecrets Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* cloudkeys_amazonsecrets_getfirewalluser(void* lpObj);
int cloudkeys_amazonsecrets_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (AmazonSecrets Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudkeys_amazonsecrets_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (AmazonSecrets Class)

The local file to write data to, or whose data should be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* cloudkeys_amazonsecrets_getlocalfile(void* lpObj);
wchar_t* cloudkeys_amazonsecrets_getlocalfile_W(void* lpObj); // Windows only
int cloudkeys_amazonsecrets_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudkeys_amazonsecrets_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

""

Remarks

This property specifies the location of a local file on disk. This is used as the source file when calling CreateSecret or CreateVersion, and as the destination file when calling GetSecret.

When creating a secret, the class assumes that data specified via a local file is binary in nature; the PreferBinary configuration setting can be used to control this behavior, refer to its documentation for more information.

Note: Setting this property to a non-empty value will discard and streams set using SetInputStream and SetOutputStream. Similarly, passing a non-null value to either of those methods will clear this property.

Data Type

String

LocalHost Property (AmazonSecrets Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* cloudkeys_amazonsecrets_getlocalhost(void* lpObj);
int cloudkeys_amazonsecrets_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

OtherHeaders Property (AmazonSecrets Class)

This property includes other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* cloudkeys_amazonsecrets_getotherheaders(void* lpObj);
int cloudkeys_amazonsecrets_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (AmazonSecrets Class)

Whether the local file should be overwritten if necessary.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int cloudkeys_amazonsecrets_getoverwrite(void* lpObj);
int cloudkeys_amazonsecrets_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property controls whether the specified LocalFile should be overwritten if it already exists.

This property is not available at design time.

Data Type

Boolean

ParsedHeaderCount Property (AmazonSecrets Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int cloudkeys_amazonsecrets_getparsedheadercount(void* lpObj);

int GetParsedHeaderCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

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

Data Type

Integer

ParsedHeaderField Property (AmazonSecrets Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderField(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);

char* cloudkeys_amazonsecrets_getparsedheaderfield(void* lpObj, int parsedheaderindex);

QString GetParsedHeaderField(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

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

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

Data Type

String

ParsedHeaderValue Property (AmazonSecrets Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderValue(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);

char* cloudkeys_amazonsecrets_getparsedheadervalue(void* lpObj, int parsedheaderindex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the Header contents.

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

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

Data Type

String

ProxyAuthScheme Property (AmazonSecrets Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int cloudkeys_amazonsecrets_getproxyauthscheme(void* lpObj);
int cloudkeys_amazonsecrets_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (AmazonSecrets Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int cloudkeys_amazonsecrets_getproxyautodetect(void* lpObj);
int cloudkeys_amazonsecrets_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (AmazonSecrets Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* cloudkeys_amazonsecrets_getproxypassword(void* lpObj);
int cloudkeys_amazonsecrets_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (AmazonSecrets Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int cloudkeys_amazonsecrets_getproxyport(void* lpObj);
int cloudkeys_amazonsecrets_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (AmazonSecrets Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* cloudkeys_amazonsecrets_getproxyserver(void* lpObj);
int cloudkeys_amazonsecrets_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (AmazonSecrets Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int cloudkeys_amazonsecrets_getproxyssl(void* lpObj);
int cloudkeys_amazonsecrets_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (AmazonSecrets Class)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* cloudkeys_amazonsecrets_getproxyuser(void* lpObj);
int cloudkeys_amazonsecrets_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (AmazonSecrets Class)

The number of records in the QueryParam arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);

Unicode (Windows)
INT GetQueryParamCount();
INT SetQueryParamCount(INT iQueryParamCount);

int cloudkeys_amazonsecrets_getqueryparamcount(void* lpObj);
int cloudkeys_amazonsecrets_setqueryparamcount(void* lpObj, int iQueryParamCount);

int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

The array indices start at 0 and end at QueryParamCount - 1.

This property is not available at design time.

Data Type

Integer

QueryParamName Property (AmazonSecrets Class)

The name of the query parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, const char* lpszQueryParamName);

Unicode (Windows)
LPWSTR GetQueryParamName(INT iQueryParamIndex);
INT SetQueryParamName(INT iQueryParamIndex, LPCWSTR lpszQueryParamName);

char* cloudkeys_amazonsecrets_getqueryparamname(void* lpObj, int queryparamindex);
int cloudkeys_amazonsecrets_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

QString GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, QString qsQueryParamName);

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

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

This property is not available at design time.

Data Type

String

QueryParamValue Property (AmazonSecrets Class)

The value of the query parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, const char* lpszQueryParamValue);

Unicode (Windows)
LPWSTR GetQueryParamValue(INT iQueryParamIndex);
INT SetQueryParamValue(INT iQueryParamIndex, LPCWSTR lpszQueryParamValue);

char* cloudkeys_amazonsecrets_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudkeys_amazonsecrets_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);

QString GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, QString qsQueryParamValue);

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

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

This property is not available at design time.

Data Type

String

Region Property (AmazonSecrets Class)

The region that the class will make requests against.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRegion();
int SetRegion(const char* lpszRegion);

Unicode (Windows)
LPWSTR GetRegion();
INT SetRegion(LPCWSTR lpszRegion);

char* cloudkeys_amazonsecrets_getregion(void* lpObj);
int cloudkeys_amazonsecrets_setregion(void* lpObj, const char* lpszRegion);

QString GetRegion();
int SetRegion(QString qsRegion);

Default Value

"us-east-1"

Remarks

This property controls which region the class will make requests against. By default the class uses us-east-1, the US East (N. Virginia) region. This property should be changed in order to create or access resources in other regions, as secrets are region-specific resources.

Regions:

The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value.

Data Type

String

SecretData Property (AmazonSecrets Class)

The binary secret data that was retrieved or that should be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSecretData(char* &lpSecretData, int &lenSecretData);
int SetSecretData(const char* lpSecretData, int lenSecretData);

Unicode (Windows)
INT GetSecretData(LPSTR &lpSecretData, INT &lenSecretData);
INT SetSecretData(LPCSTR lpSecretData, INT lenSecretData);

int cloudkeys_amazonsecrets_getsecretdata(void* lpObj, char** lpSecretData, int* lenSecretData);
int cloudkeys_amazonsecrets_setsecretdata(void* lpObj, const char* lpSecretData, int lenSecretData);

QByteArray GetSecretData();
int SetSecretData(QByteArray qbaSecretData);

Remarks

Either this property or the SecretString property is populated with secret data after calling GetSecret, depending on whether the secret data is binary or textual, so long as SetOutputStream and LocalFile are not set.

This property (or the SecretString property) can also be set before calling CreateSecret or CreateVersion; its data will be sent if SetInputStream and LocalFile are not set.

This property and SecretString are mutually exclusive; setting one will clear the other.

This property is not available at design time.

Data Type

Byte Array

SecretKey Property (AmazonSecrets Class)

The secret key to use for authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretKey();
int SetSecretKey(const char* lpszSecretKey);

Unicode (Windows)
LPWSTR GetSecretKey();
INT SetSecretKey(LPCWSTR lpszSecretKey);

char* cloudkeys_amazonsecrets_getsecretkey(void* lpObj);
int cloudkeys_amazonsecrets_setsecretkey(void* lpObj, const char* lpszSecretKey);

QString GetSecretKey();
int SetSecretKey(QString qsSecretKey);

Default Value

""

Remarks

This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server.

Data Type

String

SecretMarker Property (AmazonSecrets Class)

A marker indicating what page of secrets to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretMarker();
int SetSecretMarker(const char* lpszSecretMarker);

Unicode (Windows)
LPWSTR GetSecretMarker();
INT SetSecretMarker(LPCWSTR lpszSecretMarker);

char* cloudkeys_amazonsecrets_getsecretmarker(void* lpObj);
int cloudkeys_amazonsecrets_setsecretmarker(void* lpObj, const char* lpszSecretMarker);

QString GetSecretMarker();
int SetSecretMarker(QString qsSecretMarker);

Default Value

""

Remarks

This property will be populated when ListSecrets is called if the results are paged and there are more pages. To list all secrets, continue to call ListSecrets until this property returns empty string.

Refer to ListSecrets for more information.

This property is not available at design time.

Data Type

String

SecretCount Property (AmazonSecrets Class)

The number of records in the Secret arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSecretCount();

Unicode (Windows)
INT GetSecretCount();

int cloudkeys_amazonsecrets_getsecretcount(void* lpObj);

int GetSecretCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SecretARN
• SecretCreationDate
• SecretDeletionDate
• SecretDescription
• SecretKMSKeyId
• SecretLastAccessDate
• SecretLastChangeDate
• SecretName
• SecretOwningService

The array indices start at 0 and end at SecretCount - 1.

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

Data Type

Integer

SecretARN Property (AmazonSecrets Class)

The Amazon resource name (ARN) of the secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretARN(int iSecretIndex);

Unicode (Windows)
LPWSTR GetSecretARN(INT iSecretIndex);

char* cloudkeys_amazonsecrets_getsecretarn(void* lpObj, int secretindex);

QString GetSecretARN(int iSecretIndex);

Default Value

""

Remarks

The Amazon resource name (ARN) of the secret.

This property reflects the Amazon resource name (ARN) of the secret.

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

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

Data Type

String

SecretCreationDate Property (AmazonSecrets Class)

The creation date of the secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretCreationDate(int iSecretIndex);

Unicode (Windows)
LPWSTR GetSecretCreationDate(INT iSecretIndex);

char* cloudkeys_amazonsecrets_getsecretcreationdate(void* lpObj, int secretindex);

QString GetSecretCreationDate(int iSecretIndex);

Default Value

""

Remarks

The creation date of the secret.

This property reflects the creation date of the secret, in seconds since the Unix epoch (including fractional seconds).

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

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

Data Type

String

SecretDeletionDate Property (AmazonSecrets Class)

The deletion date of the secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretDeletionDate(int iSecretIndex);

Unicode (Windows)
LPWSTR GetSecretDeletionDate(INT iSecretIndex);

char* cloudkeys_amazonsecrets_getsecretdeletiondate(void* lpObj, int secretindex);

QString GetSecretDeletionDate(int iSecretIndex);

Default Value

""

Remarks

The deletion date of the secret.

This property reflects the deletion date of the secret, in seconds since the Unix epoch (including fractional seconds).

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

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

Data Type

String

SecretDescription Property (AmazonSecrets Class)

The secret's description.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretDescription(int iSecretIndex);

Unicode (Windows)
LPWSTR GetSecretDescription(INT iSecretIndex);

char* cloudkeys_amazonsecrets_getsecretdescription(void* lpObj, int secretindex);

QString GetSecretDescription(int iSecretIndex);

Default Value

""

Remarks

The secret's description.

This property reflects the secret's description.

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

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

Data Type

String

SecretKMSKeyId Property (AmazonSecrets Class)

The ARN or alias of the Amazon KMS KMS key used to encrypt the secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretKMSKeyId(int iSecretIndex);

Unicode (Windows)
LPWSTR GetSecretKMSKeyId(INT iSecretIndex);

char* cloudkeys_amazonsecrets_getsecretkmskeyid(void* lpObj, int secretindex);

QString GetSecretKMSKeyId(int iSecretIndex);

Default Value

""

Remarks

The ARN or alias of the Amazon KMS KMS key used to encrypt the secret.

This property reflects the ARN or alias of the Amazon KMS key used to encrypt the secret.

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

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

Data Type

String

SecretLastAccessDate Property (AmazonSecrets Class)

The last access date of the secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretLastAccessDate(int iSecretIndex);

Unicode (Windows)
LPWSTR GetSecretLastAccessDate(INT iSecretIndex);

char* cloudkeys_amazonsecrets_getsecretlastaccessdate(void* lpObj, int secretindex);

QString GetSecretLastAccessDate(int iSecretIndex);

Default Value

""

Remarks

The last access date of the secret.

This property reflects the last access date of the secret, in seconds since the Unix epoch.

Note that this property offers date-level resolution, time is not included.

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

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

Data Type

String

SecretLastChangeDate Property (AmazonSecrets Class)

The last change date of the secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretLastChangeDate(int iSecretIndex);

Unicode (Windows)
LPWSTR GetSecretLastChangeDate(INT iSecretIndex);

char* cloudkeys_amazonsecrets_getsecretlastchangedate(void* lpObj, int secretindex);

QString GetSecretLastChangeDate(int iSecretIndex);

Default Value

""

Remarks

The last change date of the secret.

This property reflects the last change date of the secret, in seconds since the Unix epoch (including fractional seconds).

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

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

Data Type

String

SecretName Property (AmazonSecrets Class)

The name of the secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretName(int iSecretIndex);

Unicode (Windows)
LPWSTR GetSecretName(INT iSecretIndex);

char* cloudkeys_amazonsecrets_getsecretname(void* lpObj, int secretindex);

QString GetSecretName(int iSecretIndex);

Default Value

""

Remarks

The name of the secret.

This property reflects the name of the secret.

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

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

Data Type

String

SecretOwningService Property (AmazonSecrets Class)

The name of the service that created the secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretOwningService(int iSecretIndex);

Unicode (Windows)
LPWSTR GetSecretOwningService(INT iSecretIndex);

char* cloudkeys_amazonsecrets_getsecretowningservice(void* lpObj, int secretindex);

QString GetSecretOwningService(int iSecretIndex);

Default Value

""

Remarks

The name of the service that created the secret.

This property reflects the name of the AWS service that created the secret.

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

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

Data Type

String

SecretString Property (AmazonSecrets Class)

The textual secret data that was retrieved or that should be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretString();
int SetSecretString(const char* lpszSecretString);

Unicode (Windows)
LPWSTR GetSecretString();
INT SetSecretString(LPCWSTR lpszSecretString);

char* cloudkeys_amazonsecrets_getsecretstring(void* lpObj);
int cloudkeys_amazonsecrets_setsecretstring(void* lpObj, const char* lpszSecretString);

QString GetSecretString();
int SetSecretString(QString qsSecretString);

Default Value

""

Remarks

Either this property or the SecretData property is populated with secret data after calling GetSecret, depending on whether the secret data is binary or textual, so long as SetOutputStream and LocalFile are not set.

This property (or the SecretData property) can also be set before calling CreateSecret or CreateVersion; its data will be sent if SetInputStream and LocalFile are not set.

This property and SecretData are mutually exclusive; setting one will clear the other.

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (AmazonSecrets Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int cloudkeys_amazonsecrets_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudkeys_amazonsecrets_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (AmazonSecrets Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int cloudkeys_amazonsecrets_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudkeys_amazonsecrets_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AmazonSecrets Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int cloudkeys_amazonsecrets_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudkeys_amazonsecrets_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (AmazonSecrets Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* cloudkeys_amazonsecrets_getsslcertstorepassword(void* lpObj);
int cloudkeys_amazonsecrets_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (AmazonSecrets Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int cloudkeys_amazonsecrets_getsslcertstoretype(void* lpObj);
int cloudkeys_amazonsecrets_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (AmazonSecrets Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* cloudkeys_amazonsecrets_getsslcertsubject(void* lpObj);
int cloudkeys_amazonsecrets_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (AmazonSecrets Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int cloudkeys_amazonsecrets_getsslprovider(void* lpObj);
int cloudkeys_amazonsecrets_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (AmazonSecrets Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int cloudkeys_amazonsecrets_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

Timeout Property (AmazonSecrets Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int cloudkeys_amazonsecrets_gettimeout(void* lpObj);
int cloudkeys_amazonsecrets_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

VersionMarker Property (AmazonSecrets Class)

A marker indicating what page of secret versions to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVersionMarker();
int SetVersionMarker(const char* lpszVersionMarker);

Unicode (Windows)
LPWSTR GetVersionMarker();
INT SetVersionMarker(LPCWSTR lpszVersionMarker);

char* cloudkeys_amazonsecrets_getversionmarker(void* lpObj);
int cloudkeys_amazonsecrets_setversionmarker(void* lpObj, const char* lpszVersionMarker);

QString GetVersionMarker();
int SetVersionMarker(QString qsVersionMarker);

Default Value

""

Remarks

This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all secret versions, continue to call ListVersions until this property returns empty string.

Refer to ListVersions for more information.

This property is not available at design time.

Data Type

String

VersionCount Property (AmazonSecrets Class)

The number of records in the Version arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetVersionCount();

Unicode (Windows)
INT GetVersionCount();

int cloudkeys_amazonsecrets_getversioncount(void* lpObj);

int GetVersionCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• VersionCreationDate
• VersionLastAccessDate
• VersionSecretARN
• VersionSecretName
• VersionStagingLabels
• VersionVersionId

The array indices start at 0 and end at VersionCount - 1.

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

Data Type

Integer

VersionCreationDate Property (AmazonSecrets Class)

The creation date of the secret version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVersionCreationDate(int iVersionIndex);

Unicode (Windows)
LPWSTR GetVersionCreationDate(INT iVersionIndex);

char* cloudkeys_amazonsecrets_getversioncreationdate(void* lpObj, int versionindex);

QString GetVersionCreationDate(int iVersionIndex);

Default Value

""

Remarks

The creation date of the secret version.

This property reflects the creation date of the secret version, in seconds since the Unix epoch (including fractional seconds).

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

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

Data Type

String

VersionLastAccessDate Property (AmazonSecrets Class)

The last access date of the secret version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVersionLastAccessDate(int iVersionIndex);

Unicode (Windows)
LPWSTR GetVersionLastAccessDate(INT iVersionIndex);

char* cloudkeys_amazonsecrets_getversionlastaccessdate(void* lpObj, int versionindex);

QString GetVersionLastAccessDate(int iVersionIndex);

Default Value

""

Remarks

The last access date of the secret version.

This property reflects the last access date of the secret version, in seconds since the Unix epoch.

Note that this property offers date-level resolution, time is not included.

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

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

Data Type

String

VersionSecretARN Property (AmazonSecrets Class)

The Amazon resource name (ARN) of the secret this is a version of.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVersionSecretARN(int iVersionIndex);

Unicode (Windows)
LPWSTR GetVersionSecretARN(INT iVersionIndex);

char* cloudkeys_amazonsecrets_getversionsecretarn(void* lpObj, int versionindex);

QString GetVersionSecretARN(int iVersionIndex);

Default Value

""

Remarks

The Amazon resource name (ARN) of the secret this is a version of.

This property reflects the Amazon resource name (ARN) of the secret that this is a version of.

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

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

Data Type

String

VersionSecretName Property (AmazonSecrets Class)

The name of the secret that this is a version of.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVersionSecretName(int iVersionIndex);

Unicode (Windows)
LPWSTR GetVersionSecretName(INT iVersionIndex);

char* cloudkeys_amazonsecrets_getversionsecretname(void* lpObj, int versionindex);

QString GetVersionSecretName(int iVersionIndex);

Default Value

""

Remarks

The name of the secret that this is a version of.

This property reflects the name of the secret that this is a version of.

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

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

Data Type

String

VersionStagingLabels Property (AmazonSecrets Class)

The staging labels attached to the secret version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVersionStagingLabels(int iVersionIndex);

Unicode (Windows)
LPWSTR GetVersionStagingLabels(INT iVersionIndex);

char* cloudkeys_amazonsecrets_getversionstaginglabels(void* lpObj, int versionindex);

QString GetVersionStagingLabels(int iVersionIndex);

Default Value

""

Remarks

The staging labels attached to the secret version.

This property reflects a comma-separated list of staging labels attached to the secret version.

Each secret version can have up to 20 staging labels attached to it at once, and a particular staging label can only be attached to one secret version at any given time.

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

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

Data Type

String

VersionVersionId Property (AmazonSecrets Class)

The Id of the secret version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVersionVersionId(int iVersionIndex);

Unicode (Windows)
LPWSTR GetVersionVersionId(INT iVersionIndex);

char* cloudkeys_amazonsecrets_getversionversionid(void* lpObj, int versionindex);

QString GetVersionVersionId(int iVersionIndex);

Default Value

""

Remarks

The Id of the secret version.

This property reflects the Id of the secret version.

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

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

Data Type

String

AddQueryParam Method (AmazonSecrets Class)

Adds a query parameter to the QueryParams properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddQueryParam(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddQueryParam(LPCWSTR lpszName, LPCWSTR lpszValue);

int cloudkeys_amazonsecrets_addqueryparam(void* lpObj, const char* lpszName, const char* lpszValue);

int AddQueryParam(const QString& qsName, const QString& qsValue);

Remarks

This method is used to add a query parameter to the QueryaParam* properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

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.)

CancelDeletion Method (AmazonSecrets Class)

Cancels the deletion of a secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CancelDeletion(const char* lpszSecretId);

Unicode (Windows)
INT CancelDeletion(LPCWSTR lpszSecretId);

int cloudkeys_amazonsecrets_canceldeletion(void* lpObj, const char* lpszSecretId);

int CancelDeletion(const QString& qsSecretId);

Remarks

This method cancels the deletion of the secret specified by SecretId. Refer to the DeleteSecret method's documentation for more information.

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

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.)

Config Method (AmazonSecrets Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* cloudkeys_amazonsecrets_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

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.

CreateSecret Method (AmazonSecrets Class)

Creates a new secret.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR CreateSecret(LPCWSTR lpszSecretName, LPCWSTR lpszDescription);

char* cloudkeys_amazonsecrets_createsecret(void* lpObj, const char* lpszSecretName, const char* lpszDescription);

QString CreateSecret(const QString& qsSecretName, const QString& qsDescription);

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.

CreateVersion Method (AmazonSecrets Class)

Creates a new secret version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateVersion(const char* lpszSecretId, const char* lpszStagingLabels);

Unicode (Windows)
LPWSTR CreateVersion(LPCWSTR lpszSecretId, LPCWSTR lpszStagingLabels);

char* cloudkeys_amazonsecrets_createversion(void* lpObj, const char* lpszSecretId, const char* lpszStagingLabels);

QString CreateVersion(const QString& qsSecretId, const QString& qsStagingLabels);

Remarks

This method creates a new version of the secret specified by SecretId. 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 newly-created secret version is returned.

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

The value passed for StagingLabels must be a comma-separated list of staging labels to attach to the new version; up to 20 staging labels can be attached to a secret version. If empty string is passed, AWSCURRENT is assumed. The server may do the following things depending on which staging labels are specified:

• If any of the specified staging labels are currently attached to other versions of this secret, they are moved from those versions to the new one.
• If the AWSCURRENT staging label is attached to the new version, the server will automatically move the AWSPREVIOUS staging label to the version that AWSCURRENT was previously attached to.

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.

DeleteSecret Method (AmazonSecrets Class)

Deletes a secret and all of its versions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteSecret(const char* lpszSecretId, int iDaysToWait);

Unicode (Windows)
INT DeleteSecret(LPCWSTR lpszSecretId, INT iDaysToWait);

int cloudkeys_amazonsecrets_deletesecret(void* lpObj, const char* lpszSecretId, int iDaysToWait);

int DeleteSecret(const QString& qsSecretId, int iDaysToWait);

Remarks

This method deletes the secret specified by SecretId, and all of its versions, either immediately or after a waiting period depending on the value passed for DaysToWait.

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

If 0 is passed for DaysToWait, the secret is deleted immediately. Otherwise, DaysToWait must be a value in the range 7 to 30 (inclusive), which will cause the secret to be scheduled for deletion. During the waiting period:

• The secret's data cannot be retrieved from any secret version.
• The deletion can be canceled by calling the CancelDeletion method.

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.)

DoEvents Method (AmazonSecrets Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int cloudkeys_amazonsecrets_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

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.)

GenRandomPassword Method (AmazonSecrets Class)

Returns a server-generated random password that complies with the given criteria.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GenRandomPassword(int iLength, int bLowercase, int bUppercase, int bNumbers, int bPunctuation, int bSpaces, const char* lpszExcludeChars, int bRequireEach);

Unicode (Windows)
LPWSTR GenRandomPassword(INT iLength, BOOL bLowercase, BOOL bUppercase, BOOL bNumbers, BOOL bPunctuation, BOOL bSpaces, LPCWSTR lpszExcludeChars, BOOL bRequireEach);

char* cloudkeys_amazonsecrets_genrandompassword(void* lpObj, int iLength, int bLowercase, int bUppercase, int bNumbers, int bPunctuation, int bSpaces, const char* lpszExcludeChars, int bRequireEach);

QString GenRandomPassword(int iLength, bool bLowercase, bool bUppercase, bool bNumbers, bool bPunctuation, bool bSpaces, const QString& qsExcludeChars, bool bRequireEach);

Remarks

This method requests and returns a random password generated by the server based on a number of criteria.

The Length parameter specifies how long the password must be; it must be a value in the range 1 to 4096 (inclusive).

The Lowercase, Uppercase, Numbers, Punctuation, and Spaces parameters specify whether the server is allowed to include characters of each type. The Lowercase and Uppercase types cover ASCII characters only. For Punctuation, the applicable characters are: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

The ExcludeChars parameters specifies a list of characters that must not be included in the password. For example, passing &" - would exclude ampersands, double quotes, spaces, and hyphens.

The RequireEach parameter specifies whether the server must include at least one of each allowed character type in the password.

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.

GetSecret Method (AmazonSecrets Class)

Retrieves a secret version's data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSecret(const char* lpszSecretId, const char* lpszVersionId, const char* lpszStagingLabel);

Unicode (Windows)
INT GetSecret(LPCWSTR lpszSecretId, LPCWSTR lpszVersionId, LPCWSTR lpszStagingLabel);

int cloudkeys_amazonsecrets_getsecret(void* lpObj, const char* lpszSecretId, const char* lpszVersionId, const char* lpszStagingLabel);

int GetSecret(const QString& qsSecretId, const QString& qsVersionId, const QString& qsStagingLabel);

Remarks

This method retrieves the secret data held by a version of the secret specified by SecretId. The exact version whose data should be retrieved is specified by either VersionId or StagingLabel (if both are specified, the latter is ignored). If neither are specified, the data from the secret version with the AWSCURRENT staging label is retrieved.

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

The secret data is returned via the output stream supplied via the SetOutputStream method, the specified LocalFile, or the SecretData or SecretString property.

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.)

GetSecretInfo Method (AmazonSecrets Class)

Gets information about a secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSecretInfo(const char* lpszSecretId);

Unicode (Windows)
INT GetSecretInfo(LPCWSTR lpszSecretId);

int cloudkeys_amazonsecrets_getsecretinfo(void* lpObj, const char* lpszSecretId);

int GetSecretInfo(const QString& qsSecretId);

Remarks

This method gets information about the secret specified by SecretId.

When the information is returned, the class clears the Secret* properties and repopulates them with a single item that contains the secret's information, and also repopulates the Version* properties (however, not all properties are populated). The SecretList and VersionList events are also fired.

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.)

ListSecrets Method (AmazonSecrets Class)

Lists secrets in the current account and region.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListSecrets();

Unicode (Windows)
INT ListSecrets();

int cloudkeys_amazonsecrets_listsecrets(void* lpObj);

int ListSecrets();

Remarks

This method lists the secrets in the current account and Region. Note that, by default, secrets that have been scheduled for deletion are not included in the results; the IncludeDeleted configuration setting can be used to control this behavior.

Calling this method will fire the SecretList event once for each secret, and will also populate the Secret* properties. If the AlwaysParseVersions configuration setting is enabled, each secret's basic version information will also be parsed and used to populate the Version* properties and fire the VersionList event.

If there are still more secrets available to list when this method returns, the SecretMarker property will be populated. Continue to call this method until SecretMarker is empty to accumulate all pages of results in the Secret* properties.

The MaxSecrets configuration setting can be used to control the maximum number of results to return at once.

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.)

ListVersions Method (AmazonSecrets Class)

List the secret versions for the specified secret.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListVersions(const char* lpszSecretId);

Unicode (Windows)
INT ListVersions(LPCWSTR lpszSecretId);

int cloudkeys_amazonsecrets_listversions(void* lpObj, const char* lpszSecretId);

int ListVersions(const QString& qsSecretId);

Remarks

This method lists the secret versions for the secret specified by SecretId. Note that by default, only non-deprecated versions are returned (i.e., those with at least one staging label attached to them); the IncludeDeprecated configuration setting can be used to control this behavior.

Calling this method will fire the VersionList event once for each secret version, and will also populate the Version* properties.

If there are still more secret versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Version* properties.

The MaxSecrets configuration setting can be used to control the maximum number of results to return at once.

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.)

MoveStagingLabel Method (AmazonSecrets Class)

Adds, removes, or moves a staging label.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int MoveStagingLabel(const char* lpszSecretId, const char* lpszStagingLabel, const char* lpszFromVersionId, const char* lpszToVersionId);

Unicode (Windows)
INT MoveStagingLabel(LPCWSTR lpszSecretId, LPCWSTR lpszStagingLabel, LPCWSTR lpszFromVersionId, LPCWSTR lpszToVersionId);

int cloudkeys_amazonsecrets_movestaginglabel(void* lpObj, const char* lpszSecretId, const char* lpszStagingLabel, const char* lpszFromVersionId, const char* lpszToVersionId);

int MoveStagingLabel(const QString& qsSecretId, const QString& qsStagingLabel, const QString& qsFromVersionId, const QString& qsToVersionId);

Remarks

This method adds, removes, or moves a staging label between versions 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 StagingLabel parameter specifies the staging label that should be added, removed, or moved. If the staging label is AWSCURRENT, it cannot be removed, only moved, and the server will automatically move the AWSPREVIOUS staging label to the secret version specified by FromVersionId.

The FromVersionId and ToVersionId parameters specify which version(s) to operate against. When adding a new staging label to a secret version, only ToVersionId must be specified. When removing a staging label from a version, only FromVersionId must be specified. When moving an existing staging label from one version to another, both FromVersionId and ToVersionId must be specified.

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.)

Reset Method (AmazonSecrets Class)

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int cloudkeys_amazonsecrets_reset(void* lpObj);

int Reset();

Remarks

This method resets the class to its initial state.

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.)

SendCustomRequest Method (AmazonSecrets Class)

Sends a custom request to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCustomRequest(const char* lpszAction, const char* lpszBody);

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszAction, LPCWSTR lpszBody);

int cloudkeys_amazonsecrets_sendcustomrequest(void* lpObj, const char* lpszAction, const char* lpszBody);

int SendCustomRequest(const QString& qsAction, const QString& qsBody);

Remarks

This method can be used to send arbitrary requests to the server. The value passed for the Action parameter must be one of the actions described in the Amazon Secrets Manager documentation.

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, based on the following:
   • Region
   • QueryParam*
2. Adds request headers from OtherHeaders.
3. Adds the specified request Body, if non-empty.
4. Signs the request.
5. Sends the request to the server.
6. Stores the response headers in the ParsedHeader* properties; and the response body in the stream specified using SetOutputStream, the specified LocalFile, or SecretData.

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

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.)

SetInputStream Method (AmazonSecrets Class)

Sets the stream whose data should be sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(CloudKeysStream* sInputStream);

Unicode (Windows)
INT SetInputStream(CloudKeysStream* sInputStream);

int cloudkeys_amazonsecrets_setinputstream(void* lpObj, CloudKeysStream* sInputStream);

int SetInputStream(CloudKeysStream* sInputStream);

Remarks

This method sets the stream whose data should be sent when CreateSecret or CreateVersion is called. The class assumes that any data specified via an input stream is binary in nature; the PreferBinary configuration setting can be used to control this behavior, refer to its documentation for more information.

Note: Passing a non-null value for InputStream will cause the LocalFile property to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

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.)

SetOutputStream Method (AmazonSecrets Class)

Sets the stream to which received data should be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetOutputStream(CloudKeysStream* sOutputStream);

Unicode (Windows)
INT SetOutputStream(CloudKeysStream* sOutputStream);

int cloudkeys_amazonsecrets_setoutputstream(void* lpObj, CloudKeysStream* sOutputStream);

int SetOutputStream(CloudKeysStream* sOutputStream);

Remarks

This method sets the stream to which data should be written when GetSecret is called.

Note: Passing a non-null value for OutputStream will cause the LocalFile property to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

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.)

UpdateSecret Method (AmazonSecrets Class)

Updates a secret's information.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT UpdateSecret(LPCWSTR lpszSecretId, LPCWSTR lpszDescription);

int cloudkeys_amazonsecrets_updatesecret(void* lpObj, const char* lpszSecretId, const char* lpszDescription);

int UpdateSecret(const QString& qsSecretId, const QString& qsDescription);

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 AWS KMS key used to encrypt the secret. However, if the KMS key 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 KMS key and re-encrypts it using the new one. If the old KMS key 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.)

EndTransfer Event (AmazonSecrets Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(AmazonSecretsEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} AmazonSecretsEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(AmazonSecretsEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} AmazonSecretsEndTransferEventParams;

#define EID_AMAZONSECRETS_ENDTRANSFER 1

virtual INT CLOUDKEYS_CALL FireEndTransfer(INT &iDirection);

class AmazonSecretsEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(AmazonSecretsEndTransferEventParams *e);

// Or, subclass AmazonSecrets and override this emitter function.
virtual int FireEndTransfer(AmazonSecretsEndTransferEventParams *e) {...}

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (AmazonSecrets Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(AmazonSecretsErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} AmazonSecretsErrorEventParams;


Unicode (Windows)
virtual INT FireError(AmazonSecretsErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} AmazonSecretsErrorEventParams;

#define EID_AMAZONSECRETS_ERROR 2

virtual INT CLOUDKEYS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class AmazonSecretsErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(AmazonSecretsErrorEventParams *e);

// Or, subclass AmazonSecrets and override this emitter function.
virtual int FireError(AmazonSecretsErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (AmazonSecrets Class)

This event is fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(AmazonSecretsHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} AmazonSecretsHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(AmazonSecretsHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} AmazonSecretsHeaderEventParams;

#define EID_AMAZONSECRETS_HEADER 3

virtual INT CLOUDKEYS_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class AmazonSecretsHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(AmazonSecretsHeaderEventParams *e);

// Or, subclass AmazonSecrets and override this emitter function.
virtual int FireHeader(AmazonSecretsHeaderEventParams *e) {...}

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (AmazonSecrets Class)

This event fires once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(AmazonSecretsLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} AmazonSecretsLogEventParams;


Unicode (Windows)
virtual INT FireLog(AmazonSecretsLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} AmazonSecretsLogEventParams;

#define EID_AMAZONSECRETS_LOG 4

virtual INT CLOUDKEYS_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class AmazonSecretsLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(AmazonSecretsLogEventParams *e);

// Or, subclass AmazonSecrets and override this emitter function.
virtual int FireLog(AmazonSecretsLogEventParams *e) {...}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

SecretList Event (AmazonSecrets Class)

Fires once for each secret when listing secrets.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSecretList(AmazonSecretsSecretListEventParams *e);

typedef struct {
  const char *ARN;
  const char *Name;
  const char *Description;
  const char *CreationDate;
  const char *DeletionDate;
  const char *LastAccessDate;
  const char *LastChangeDate;
  int reserved;
} AmazonSecretsSecretListEventParams;


Unicode (Windows)
virtual INT FireSecretList(AmazonSecretsSecretListEventParams *e);

typedef struct {
  LPCWSTR ARN;
  LPCWSTR Name;
  LPCWSTR Description;
  LPCWSTR CreationDate;
  LPCWSTR DeletionDate;
  LPCWSTR LastAccessDate;
  LPCWSTR LastChangeDate;
  INT reserved;
} AmazonSecretsSecretListEventParams;

#define EID_AMAZONSECRETS_SECRETLIST 5

virtual INT CLOUDKEYS_CALL FireSecretList(LPSTR &lpszARN, LPSTR &lpszName, LPSTR &lpszDescription, LPSTR &lpszCreationDate, LPSTR &lpszDeletionDate, LPSTR &lpszLastAccessDate, LPSTR &lpszLastChangeDate);

class AmazonSecretsSecretListEventParams {
public:
  const QString &ARN();

  const QString &Name();

  const QString &Description();

  const QString &CreationDate();

  const QString &DeletionDate();

  const QString &LastAccessDate();

  const QString &LastChangeDate();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SecretList(AmazonSecretsSecretListEventParams *e);

// Or, subclass AmazonSecrets and override this emitter function.
virtual int FireSecretList(AmazonSecretsSecretListEventParams *e) {...}

Remarks

This event fires once for each secret returned when ListSecrets or GetSecretInfo is called.

ARN reflects the Amazon resource name of the secret.

Name reflects the name of the secret.

Description reflects the secret's description.

CreationDate reflects the secret's creation date, in seconds since the Unix epoch (including fractional seconds).

DeletionDate reflects the secret's scheduled deletion date, if applicable, in seconds since the Unix epoch (including fractional seconds).

LastAccessDate reflects the secret's last access date, in seconds since the Unix epoch. It provides date-level resolution only, the time is not included.

LastChangeDate reflects the secret's last change date, in seconds since the Unix epoch (including fractional seconds).

SSLServerAuthentication Event (AmazonSecrets Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(AmazonSecretsSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} AmazonSecretsSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(AmazonSecretsSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} AmazonSecretsSSLServerAuthenticationEventParams;

#define EID_AMAZONSECRETS_SSLSERVERAUTHENTICATION 6

virtual INT CLOUDKEYS_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class AmazonSecretsSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(AmazonSecretsSSLServerAuthenticationEventParams *e);

// Or, subclass AmazonSecrets and override this emitter function.
virtual int FireSSLServerAuthentication(AmazonSecretsSSLServerAuthenticationEventParams *e) {...}

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (AmazonSecrets Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(AmazonSecretsSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} AmazonSecretsSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(AmazonSecretsSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} AmazonSecretsSSLStatusEventParams;

#define EID_AMAZONSECRETS_SSLSTATUS 7

virtual INT CLOUDKEYS_CALL FireSSLStatus(LPSTR &lpszMessage);

class AmazonSecretsSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(AmazonSecretsSSLStatusEventParams *e);

// Or, subclass AmazonSecrets and override this emitter function.
virtual int FireSSLStatus(AmazonSecretsSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (AmazonSecrets Class)

This event fires when a document starts transferring (after the headers).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(AmazonSecretsStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} AmazonSecretsStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(AmazonSecretsStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} AmazonSecretsStartTransferEventParams;

#define EID_AMAZONSECRETS_STARTTRANSFER 8

virtual INT CLOUDKEYS_CALL FireStartTransfer(INT &iDirection);

class AmazonSecretsStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(AmazonSecretsStartTransferEventParams *e);

// Or, subclass AmazonSecrets and override this emitter function.
virtual int FireStartTransfer(AmazonSecretsStartTransferEventParams *e) {...}

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (AmazonSecrets Class)

This event is fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(AmazonSecretsTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} AmazonSecretsTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(AmazonSecretsTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} AmazonSecretsTransferEventParams;

#define EID_AMAZONSECRETS_TRANSFER 9

virtual INT CLOUDKEYS_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class AmazonSecretsTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(AmazonSecretsTransferEventParams *e);

// Or, subclass AmazonSecrets and override this emitter function.
virtual int FireTransfer(AmazonSecretsTransferEventParams *e) {...}

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

VersionList Event (AmazonSecrets Class)

Fires once for each secret version when listing secret versions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireVersionList(AmazonSecretsVersionListEventParams *e);

typedef struct {
  const char *SecretARN;
  const char *SecretName;
  const char *VersionId;
  const char *StagingLabels;
  const char *CreationDate;
  const char *LastAccessDate;
  int reserved;
} AmazonSecretsVersionListEventParams;


Unicode (Windows)
virtual INT FireVersionList(AmazonSecretsVersionListEventParams *e);

typedef struct {
  LPCWSTR SecretARN;
  LPCWSTR SecretName;
  LPCWSTR VersionId;
  LPCWSTR StagingLabels;
  LPCWSTR CreationDate;
  LPCWSTR LastAccessDate;
  INT reserved;
} AmazonSecretsVersionListEventParams;

#define EID_AMAZONSECRETS_VERSIONLIST 10

virtual INT CLOUDKEYS_CALL FireVersionList(LPSTR &lpszSecretARN, LPSTR &lpszSecretName, LPSTR &lpszVersionId, LPSTR &lpszStagingLabels, LPSTR &lpszCreationDate, LPSTR &lpszLastAccessDate);

class AmazonSecretsVersionListEventParams {
public:
  const QString &SecretARN();

  const QString &SecretName();

  const QString &VersionId();

  const QString &StagingLabels();

  const QString &CreationDate();

  const QString &LastAccessDate();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void VersionList(AmazonSecretsVersionListEventParams *e);

// Or, subclass AmazonSecrets and override this emitter function.
virtual int FireVersionList(AmazonSecretsVersionListEventParams *e) {...}

Remarks

This event fires once for each secret version returned when ListVersions, GetSecretInfo, or (if the AlwaysParseVersions configuration setting is enabled) ListSecrets is called. Note that CreationDate and LastAccessDate are only populated when ListVersions is called.

SecretARN reflects the Amazon resource name of the secret this is a version of.

SecretName reflects the name of the secret this is a version of.

VersionId reflects the Id of the secret version.

StagingLabels reflects a comma-separated list of staging labels attached to the secret version.

CreationDate reflects the secret version's creation date, in seconds since the Unix epoch (including fractional seconds).

LastAccessDate reflects the secret version's last access date, in seconds since the Unix epoch. It provides date-level resolution only, the time is not included.

CloudKeysStream Type

Syntax

CloudKeysStream (declared in cloudkeys.h)

Remarks

The AmazonSecrets class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the CloudKeysStream interface and pass the AmazonSecrets class an instance of that concrete class.

When implementing the CloudKeysStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (AmazonSecrets Class)

AmazonSecrets Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings