Reference documentation and code samples for the Google Cloud Functions V1 Client class SecretVolume.
Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container. Secret value is not a part of the configuration. Every filesystem read operation performs a lookup in secret manager to retrieve the secret value.
Generated from protobuf message google.cloud.functions.v1.SecretVolume
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ mount_path
string
The path within the container to mount the secret volume. For example, setting the mount_path as /etc/secrets
would mount the secret value files under the /etc/secrets
directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log
↳ project_id
string
Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.
↳ secret
string
Name of the secret in secret manager (not the full resource name).
↳ versions
array< Google\Cloud\Functions\V1\SecretVolume\SecretVersion
>
List of secret versions to mount for this secret. If empty, the latest
version of the secret will be made available in a file named after the secret under the mount point.
getMountPath
The path within the container to mount the secret volume. For example,
setting the mount_path as /etc/secrets
would mount the secret value files
under the /etc/secrets
directory. This directory will also be completely
shadowed and unavailable to mount any other secrets.
Recommended mount paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log
string
setMountPath
The path within the container to mount the secret volume. For example,
setting the mount_path as /etc/secrets
would mount the secret value files
under the /etc/secrets
directory. This directory will also be completely
shadowed and unavailable to mount any other secrets.
Recommended mount paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log
var
string
$this
getProjectId
Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.
string
setProjectId
Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.
var
string
$this
getSecret
Name of the secret in secret manager (not the full resource name).
string
setSecret
Name of the secret in secret manager (not the full resource name).
var
string
$this
getVersions
List of secret versions to mount for this secret. If empty, the latest
version of the secret will be made available in a file named after the
secret under the mount point.
setVersions
List of secret versions to mount for this secret. If empty, the latest
version of the secret will be made available in a file named after the
secret under the mount point.
$this
