SecretString Property

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

Syntax

 amazonsecrets.getSecretString([callback])
 amazonsecrets.setSecretString( secretString, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSecretString([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSecretString([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

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 LocalFile is not set.

This property (or the SecretData property) can also be set before calling CreateSecret or CreateVersion; its data will be sent if LocalFile is 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