Class: Google::Apis::CloudfunctionsV2::SecretVolume

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudfunctions_v2/classes.rb,
lib/google/apis/cloudfunctions_v2/representations.rb,
lib/google/apis/cloudfunctions_v2/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SecretVolume

Returns a new instance of SecretVolume.



1708
1709
1710
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1708

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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 path: /etc/secrets Corresponds to the JSON property mountPath

Returns:

  • (String) 


1687
1688
1689
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1687

def mount_path
  @mount_path
end

#project_id ⇒ String

Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function. Corresponds to the JSON property projectId

Returns:

  • (String) 


1694
1695
1696
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1694

def project_id
  @project_id
end

#secret ⇒ String

Name of the secret in secret manager (not the full resource name). Corresponds to the JSON property secret

Returns:

  • (String) 


1699
1700
1701
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1699

def secret
  @secret
end

#versions ⇒ Array<Google::Apis::CloudfunctionsV2::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. Corresponds to the JSON property versions

Returns:



1706
1707
1708
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1706

def versions
  @versions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1713
1714
1715
1716
1717
1718
 
# File 'lib/google/apis/cloudfunctions_v2/classes.rb', line 1713

def update!(**args)
  @mount_path = args[:mount_path] if args.key?(:mount_path)
  @project_id = args[:project_id] if args.key?(:project_id)
  @secret = args[:secret] if args.key?(:secret)
  @versions = args[:versions] if args.key?(:versions)
end