Optional props: ClientOptionsReadonly baseThe Extension's base URL endpoint. Protocol + host + port number.
http://localhost:2773
Private Readonly requesterAn object capable of making a HTTP GET Request
FetchRequester
Get a Secrets Manager BinarySecret Value as a Buffer from the Extension.
Converts the Extension's Base64 string response to a Buffer.
the secret id
Optional options: SecretOptionsoptional qualifiers.
a Promise of a Binary Secret as a Buffer. null` if error or undefined.
Get a Binary Secret from the SSM Parameter Store using the Extension.
Always returns the decrypted value. The WithDecryption flag must be True for retrieving a Secret Manager secret.
the BinarySecret secret name
Optional options: SecretFromParamStoreOptionsoptional qualifiers. The Client sets withDecryption: true by default.
a Promise of a Binary Secret as a Buffer. null` if error or undefined.
Private getGet the resource.
Get the full Response object from the Extension for a SSM Parameter
the parameter name
Optional options: ParameterOptionsoptional qualifiers
a Promise of the full response object returned by the Extension.
Get the full Response object from the Extension for a SecretManager Secret.
For Binary Secrets "The response parameter represents the binary data as a base64-encoded string."
(GetSecretValueCommandOutput)
the secret id
Optional options: SecretOptionsoptional qualifiers.
a Promise of the full response object returned by the Extension
Get a SSM String Parameter List Value from the Extension.
the SecureString parameter name
Optional options: SecureStringParameterOptionsoptional qualifiers. The Client sets withDecryption: true by default.
a Promise of the parameter's value. null if error or undefined.
Get a SSM String Parameter List Values as an array from the Extension.
Use the stringParameter method to return the stringified value of a StringList.
the StringList parameter name
Optional options: StringParameterOptionsoptional qualifiers
a Promise of the parameter's values as an array. null if error or undefined.
Get a SSM String Parameter Value for from the Extension.
If parameterName returns a comma-deliminated string for a StringList
and the decrypted value of a SecureString.
the String or StringList parameter name
Optional options: StringParameterOptionsoptional qualifiers
a Promise of the parameter's string valu. null if error or undefined.
Get a String Secret from the SSM Parameter Store using the Extension.
Always returns the decrypted value. The WithDecryption flag must be True for retrieving a Secret Manager secret.
the StringSecret secret name
Optional options: SecretFromParamStoreOptionsoptional qualifiers. The Client sets withDecryption: true by default.
a Promise of the parameter's value. null if error or undefined.
Generated using TypeDoc
The Client makes requests to the
http:localhostendpoint exposed by the AWS Parameters and Secrets Lambda Extension.