public sealed class SecretVolume : IMessage<SecretVolume>, IEquatable<SecretVolume>, IDeepCloneable<SecretVolume>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud Functions v1 API 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 file system read operation performs a lookup in Secret Manager to retrieve the secret value.
Implements
IMessageSecretVolume, IEquatableSecretVolume, IDeepCloneableSecretVolume, IBufferMessage, IMessageNamespace
Google.Cloud.Functions.V1Assembly
Google.Cloud.Functions.V1.dll
Constructors
SecretVolume()
public SecretVolume()
SecretVolume(SecretVolume)
public SecretVolume(SecretVolume other)
Parameter | |
---|---|
Name | Description |
other | SecretVolume |
Properties
MountPath
public string MountPath { get; set; }
The path within the container to mount the secret volume. For example,
setting the mount_path as /etc/secrets
mounts the secret value files
under the /etc/secrets
directory. This directory is also completely
shadowed and unavailable to mount any other secrets.
Recommended mount paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log
Property Value | |
---|---|
Type | Description |
string |
ProjectId
public string ProjectId { get; set; }
Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it is populated with the function's project, assuming that the secret exists in the same project as the function.
Property Value | |
---|---|
Type | Description |
string |
Secret
public string Secret { get; set; }
Name of the secret in Secret Manager (not the full resource name).
Property Value | |
---|---|
Type | Description |
string |
Versions
public RepeatedField<SecretVolume.Types.SecretVersion> Versions { get; }
List of secret versions to mount for this secret. If empty, the latest
version of the secret is made available in a file named after the
secret under the mount point.
Property Value | |
---|---|
Type | Description |
RepeatedFieldSecretVolumeTypesSecretVersion |