A parametrized string whose value is stored in Cloud Secret Manager instead of the local filesystem. Supply instances of SecretParams to the secrets array while defining a Function to make their values accessible during execution of that Function.
Signature:
export declare class SecretParam
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(name, options) | Constructs a new instance of the SecretParam class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| name | string | ||
| options | SecretParamOptions | ||
| type | static |
ParamValueType |
Methods
| Method | Modifiers | Description |
|---|---|---|
| value() | Returns the secret's value at runtime. Throws an error if accessed during deployment. |
params.SecretParam.(constructor)
Constructs a new instance of the SecretParam class
Signature:
constructor(name: string, options?: SecretParamOptions);
Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | |
| options | SecretParamOptions |
params.SecretParam.name
Signature:
name: string;
params.SecretParam.options
Signature:
readonly options: SecretParamOptions;
params.SecretParam.type
Signature:
static type: ParamValueType;
params.SecretParam.value()
Returns the secret's value at runtime. Throws an error if accessed during deployment.
Signature:
value(): string;
Returns:
string