Google Native

Pulumi Official
Package maintained by Pulumi
v0.23.0 published on Thursday, Aug 11, 2022 by Pulumi

getFunction

Returns a function with the given name from the requested project.

Using getFunction

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFunction(args: GetFunctionArgs, opts?: InvokeOptions): Promise<GetFunctionResult>
function getFunctionOutput(args: GetFunctionOutputArgs, opts?: InvokeOptions): Output<GetFunctionResult>
def get_function(function_id: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFunctionResult
def get_function_output(function_id: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetFunctionResult]
func LookupFunction(ctx *Context, args *LookupFunctionArgs, opts ...InvokeOption) (*LookupFunctionResult, error)
func LookupFunctionOutput(ctx *Context, args *LookupFunctionOutputArgs, opts ...InvokeOption) LookupFunctionResultOutput

> Note: This function is named LookupFunction in the Go SDK.

public static class GetFunction 
{
    public static Task<GetFunctionResult> InvokeAsync(GetFunctionArgs args, InvokeOptions? opts = null)
    public static Output<GetFunctionResult> Invoke(GetFunctionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFunctionResult> getFunction(GetFunctionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:cloudfunctions/v1:getFunction
  Arguments:
    # Arguments dictionary

The following arguments are supported:

FunctionId string
Location string
Project string
FunctionId string
Location string
Project string
functionId String
location String
project String
functionId string
location string
project string
functionId String
location String
project String

getFunction Result

The following output properties are available:

AvailableMemoryMb int

The amount of memory in MB available for a function. Defaults to 256MB.

BuildEnvironmentVariables Dictionary<string, string>

Build environment variables that shall be available during build time.

BuildId string

The Cloud Build ID of the latest successful deployment of the function.

BuildName string

The Cloud Build Name of the function deployment. projects//locations//builds/.

BuildWorkerPool string

Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

Description string

User-provided description of a function.

DockerRegistry string

Docker Registry to use for this deployment. If docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.

DockerRepository string

User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.

EntryPoint string

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in source_location.

EnvironmentVariables Dictionary<string, string>

Environment variables that shall be available during function execution.

EventTrigger Pulumi.GoogleNative.CloudFunctions.V1.Outputs.EventTriggerResponse

A source that fires events in response to a condition in another service.

HttpsTrigger Pulumi.GoogleNative.CloudFunctions.V1.Outputs.HttpsTriggerResponse

An HTTPS endpoint type of source that can be triggered via URL.

IngressSettings string

The ingress settings for the function, controlling what traffic can reach it.

KmsKeyName string

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.

Labels Dictionary<string, string>

Labels associated with this Cloud Function.

MaxInstances int

The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.

MinInstances int

A lower bound for the number function instances that may coexist at a given time.

Name string

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

Network string

The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either projects/{project}/global/networks/{network} or {network}, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with vpc_connector and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.

Runtime string

The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.

SecretEnvironmentVariables List<Pulumi.GoogleNative.CloudFunctions.V1.Outputs.SecretEnvVarResponse>

Secret environment variables configuration.

SecretVolumes List<Pulumi.GoogleNative.CloudFunctions.V1.Outputs.SecretVolumeResponse>

Secret volumes configuration.

ServiceAccountEmail string

The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

SourceArchiveUrl string

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

SourceRepository Pulumi.GoogleNative.CloudFunctions.V1.Outputs.SourceRepositoryResponse

Beta Feature The source repository where a function is hosted.

SourceToken string

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

SourceUploadUrl string

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)

Status string

Status of the function deployment.

Timeout string

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

UpdateTime string

The last update timestamp of a Cloud Function.

VersionId string

The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

VpcConnector string

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/* This field is mutually exclusive with network field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.

VpcConnectorEgressSettings string

The egress settings for the connector, controlling what traffic is diverted through it.

AvailableMemoryMb int

The amount of memory in MB available for a function. Defaults to 256MB.

BuildEnvironmentVariables map[string]string

Build environment variables that shall be available during build time.

BuildId string

The Cloud Build ID of the latest successful deployment of the function.

BuildName string

The Cloud Build Name of the function deployment. projects//locations//builds/.

BuildWorkerPool string

Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

Description string

User-provided description of a function.

DockerRegistry string

Docker Registry to use for this deployment. If docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.

DockerRepository string

User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.

EntryPoint string

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in source_location.

EnvironmentVariables map[string]string

Environment variables that shall be available during function execution.

EventTrigger EventTriggerResponse

A source that fires events in response to a condition in another service.

HttpsTrigger HttpsTriggerResponse

An HTTPS endpoint type of source that can be triggered via URL.

IngressSettings string

The ingress settings for the function, controlling what traffic can reach it.

KmsKeyName string

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.

Labels map[string]string

Labels associated with this Cloud Function.

MaxInstances int

The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.

MinInstances int

A lower bound for the number function instances that may coexist at a given time.

Name string

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

Network string

The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either projects/{project}/global/networks/{network} or {network}, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with vpc_connector and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.

Runtime string

The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.

SecretEnvironmentVariables []SecretEnvVarResponse

Secret environment variables configuration.

SecretVolumes []SecretVolumeResponse

Secret volumes configuration.

ServiceAccountEmail string

The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

SourceArchiveUrl string

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

SourceRepository SourceRepositoryResponse

Beta Feature The source repository where a function is hosted.

SourceToken string

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

SourceUploadUrl string

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)

Status string

Status of the function deployment.

Timeout string

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

UpdateTime string

The last update timestamp of a Cloud Function.

VersionId string

The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

VpcConnector string

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/* This field is mutually exclusive with network field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.

VpcConnectorEgressSettings string

The egress settings for the connector, controlling what traffic is diverted through it.

availableMemoryMb Integer

The amount of memory in MB available for a function. Defaults to 256MB.

buildEnvironmentVariables Map<String,String>

Build environment variables that shall be available during build time.

buildId String

The Cloud Build ID of the latest successful deployment of the function.

buildName String

The Cloud Build Name of the function deployment. projects//locations//builds/.

buildWorkerPool String

Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

description String

User-provided description of a function.

dockerRegistry String

Docker Registry to use for this deployment. If docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.

dockerRepository String

User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.

entryPoint String

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in source_location.

environmentVariables Map<String,String>

Environment variables that shall be available during function execution.

eventTrigger EventTriggerResponse

A source that fires events in response to a condition in another service.

httpsTrigger HttpsTriggerResponse

An HTTPS endpoint type of source that can be triggered via URL.

ingressSettings String

The ingress settings for the function, controlling what traffic can reach it.

kmsKeyName String

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.

labels Map<String,String>

Labels associated with this Cloud Function.

maxInstances Integer

The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.

minInstances Integer

A lower bound for the number function instances that may coexist at a given time.

name String

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

network String

The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either projects/{project}/global/networks/{network} or {network}, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with vpc_connector and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.

runtime String

The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.

secretEnvironmentVariables List<SecretEnvVarResponse>

Secret environment variables configuration.

secretVolumes List<SecretVolumeResponse>

Secret volumes configuration.

serviceAccountEmail String

The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

sourceArchiveUrl String

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

sourceRepository SourceRepositoryResponse

Beta Feature The source repository where a function is hosted.

sourceToken String

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

sourceUploadUrl String

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)

status String

Status of the function deployment.

timeout String

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

updateTime String

The last update timestamp of a Cloud Function.

versionId String

The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

vpcConnector String

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/* This field is mutually exclusive with network field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.

vpcConnectorEgressSettings String

The egress settings for the connector, controlling what traffic is diverted through it.

availableMemoryMb number

The amount of memory in MB available for a function. Defaults to 256MB.

buildEnvironmentVariables {[key: string]: string}

Build environment variables that shall be available during build time.

buildId string

The Cloud Build ID of the latest successful deployment of the function.

buildName string

The Cloud Build Name of the function deployment. projects//locations//builds/.

buildWorkerPool string

Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

description string

User-provided description of a function.

dockerRegistry string

Docker Registry to use for this deployment. If docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.

dockerRepository string

User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.

entryPoint string

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in source_location.

environmentVariables {[key: string]: string}

Environment variables that shall be available during function execution.

eventTrigger EventTriggerResponse

A source that fires events in response to a condition in another service.

httpsTrigger HttpsTriggerResponse

An HTTPS endpoint type of source that can be triggered via URL.

ingressSettings string

The ingress settings for the function, controlling what traffic can reach it.

kmsKeyName string

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.

labels {[key: string]: string}

Labels associated with this Cloud Function.

maxInstances number

The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.

minInstances number

A lower bound for the number function instances that may coexist at a given time.

name string

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

network string

The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either projects/{project}/global/networks/{network} or {network}, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with vpc_connector and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.

runtime string

The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.

secretEnvironmentVariables SecretEnvVarResponse[]

Secret environment variables configuration.

secretVolumes SecretVolumeResponse[]

Secret volumes configuration.

serviceAccountEmail string

The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

sourceArchiveUrl string

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

sourceRepository SourceRepositoryResponse

Beta Feature The source repository where a function is hosted.

sourceToken string

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

sourceUploadUrl string

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)

status string

Status of the function deployment.

timeout string

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

updateTime string

The last update timestamp of a Cloud Function.

versionId string

The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

vpcConnector string

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/* This field is mutually exclusive with network field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.

vpcConnectorEgressSettings string

The egress settings for the connector, controlling what traffic is diverted through it.

available_memory_mb int

The amount of memory in MB available for a function. Defaults to 256MB.

build_environment_variables Mapping[str, str]

Build environment variables that shall be available during build time.

build_id str

The Cloud Build ID of the latest successful deployment of the function.

build_name str

The Cloud Build Name of the function deployment. projects//locations//builds/.

build_worker_pool str

Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

description str

User-provided description of a function.

docker_registry str

Docker Registry to use for this deployment. If docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.

docker_repository str

User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.

entry_point str

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in source_location.

environment_variables Mapping[str, str]

Environment variables that shall be available during function execution.

event_trigger EventTriggerResponse

A source that fires events in response to a condition in another service.

https_trigger HttpsTriggerResponse

An HTTPS endpoint type of source that can be triggered via URL.

ingress_settings str

The ingress settings for the function, controlling what traffic can reach it.

kms_key_name str

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.

labels Mapping[str, str]

Labels associated with this Cloud Function.

max_instances int

The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.

min_instances int

A lower bound for the number function instances that may coexist at a given time.

name str

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

network str

The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either projects/{project}/global/networks/{network} or {network}, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with vpc_connector and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.

runtime str

The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.

secret_environment_variables Sequence[SecretEnvVarResponse]

Secret environment variables configuration.

secret_volumes Sequence[SecretVolumeResponse]

Secret volumes configuration.

service_account_email str

The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

source_archive_url str

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

source_repository SourceRepositoryResponse

Beta Feature The source repository where a function is hosted.

source_token str

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

source_upload_url str

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)

status str

Status of the function deployment.

timeout str

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

update_time str

The last update timestamp of a Cloud Function.

version_id str

The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

vpc_connector str

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/* This field is mutually exclusive with network field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.

vpc_connector_egress_settings str

The egress settings for the connector, controlling what traffic is diverted through it.

availableMemoryMb Number

The amount of memory in MB available for a function. Defaults to 256MB.

buildEnvironmentVariables Map<String>

Build environment variables that shall be available during build time.

buildId String

The Cloud Build ID of the latest successful deployment of the function.

buildName String

The Cloud Build Name of the function deployment. projects//locations//builds/.

buildWorkerPool String

Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

description String

User-provided description of a function.

dockerRegistry String

Docker Registry to use for this deployment. If docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.

dockerRepository String

User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.

entryPoint String

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in source_location.

environmentVariables Map<String>

Environment variables that shall be available during function execution.

eventTrigger Property Map

A source that fires events in response to a condition in another service.

httpsTrigger Property Map

An HTTPS endpoint type of source that can be triggered via URL.

ingressSettings String

The ingress settings for the function, controlling what traffic can reach it.

kmsKeyName String

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.

labels Map<String>

Labels associated with this Cloud Function.

maxInstances Number

The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.

minInstances Number

A lower bound for the number function instances that may coexist at a given time.

name String

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

network String

The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either projects/{project}/global/networks/{network} or {network}, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with vpc_connector and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.

runtime String

The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.

secretEnvironmentVariables List<Property Map>

Secret environment variables configuration.

secretVolumes List<Property Map>

Secret volumes configuration.

serviceAccountEmail String

The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

sourceArchiveUrl String

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

sourceRepository Property Map

Beta Feature The source repository where a function is hosted.

sourceToken String

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

sourceUploadUrl String

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)

status String

Status of the function deployment.

timeout String

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

updateTime String

The last update timestamp of a Cloud Function.

versionId String

The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

vpcConnector String

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/* This field is mutually exclusive with network field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.

vpcConnectorEgressSettings String

The egress settings for the connector, controlling what traffic is diverted through it.

Supporting Types

EventTriggerResponse

EventType string

The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish. Event types match pattern providers/*/eventTypes/*.*. The pattern contains: 1. namespace: For example, cloud.storage and google.firebase.analytics. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.

FailurePolicy Pulumi.GoogleNative.CloudFunctions.V1.Inputs.FailurePolicyResponse

Specifies policy for failed executions.

Resource string

The resource(s) from which to observe events, for example, projects/_/buckets/myBucket. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction. 2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_type of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.

Service string

The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, storage.googleapis.com is the default for all event types in the google.storage namespace.

EventType string

The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish. Event types match pattern providers/*/eventTypes/*.*. The pattern contains: 1. namespace: For example, cloud.storage and google.firebase.analytics. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.

FailurePolicy FailurePolicyResponse

Specifies policy for failed executions.

Resource string

The resource(s) from which to observe events, for example, projects/_/buckets/myBucket. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction. 2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_type of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.

Service string

The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, storage.googleapis.com is the default for all event types in the google.storage namespace.

eventType String

The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish. Event types match pattern providers/*/eventTypes/*.*. The pattern contains: 1. namespace: For example, cloud.storage and google.firebase.analytics. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.

failurePolicy FailurePolicyResponse

Specifies policy for failed executions.

resource String

The resource(s) from which to observe events, for example, projects/_/buckets/myBucket. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction. 2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_type of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.

service String

The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, storage.googleapis.com is the default for all event types in the google.storage namespace.

eventType string

The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish. Event types match pattern providers/*/eventTypes/*.*. The pattern contains: 1. namespace: For example, cloud.storage and google.firebase.analytics. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.

failurePolicy FailurePolicyResponse

Specifies policy for failed executions.

resource string

The resource(s) from which to observe events, for example, projects/_/buckets/myBucket. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction. 2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_type of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.

service string

The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, storage.googleapis.com is the default for all event types in the google.storage namespace.

event_type str

The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish. Event types match pattern providers/*/eventTypes/*.*. The pattern contains: 1. namespace: For example, cloud.storage and google.firebase.analytics. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.

failure_policy FailurePolicyResponse

Specifies policy for failed executions.

resource str

The resource(s) from which to observe events, for example, projects/_/buckets/myBucket. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction. 2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_type of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.

service str

The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, storage.googleapis.com is the default for all event types in the google.storage namespace.

eventType String

The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish. Event types match pattern providers/*/eventTypes/*.*. The pattern contains: 1. namespace: For example, cloud.storage and google.firebase.analytics. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.

failurePolicy Property Map

Specifies policy for failed executions.

resource String

The resource(s) from which to observe events, for example, projects/_/buckets/myBucket. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction. 2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_type of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.

service String

The hostname of the service that should be observed. If no string is provided, the default service implementing the API will be used. For example, storage.googleapis.com is the default for all event types in the google.storage namespace.

FailurePolicyResponse

Retry Pulumi.GoogleNative.CloudFunctions.V1.Inputs.RetryResponse

If specified, then the function will be retried in case of a failure.

Retry RetryResponse

If specified, then the function will be retried in case of a failure.

retry RetryResponse

If specified, then the function will be retried in case of a failure.

retry RetryResponse

If specified, then the function will be retried in case of a failure.

retry RetryResponse

If specified, then the function will be retried in case of a failure.

retry Property Map

If specified, then the function will be retried in case of a failure.

HttpsTriggerResponse

SecurityLevel string

The security level for the function.

Url string

The deployed url for the function.

SecurityLevel string

The security level for the function.

Url string

The deployed url for the function.

securityLevel String

The security level for the function.

url String

The deployed url for the function.

securityLevel string

The security level for the function.

url string

The deployed url for the function.

security_level str

The security level for the function.

url str

The deployed url for the function.

securityLevel String

The security level for the function.

url String

The deployed url for the function.

SecretEnvVarResponse

Key string

Name of the environment variable.

Project 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).

Version string

Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.

Key string

Name of the environment variable.

Project 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).

Version string

Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.

key String

Name of the environment variable.

project 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).

version String

Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.

key string

Name of the environment variable.

project 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).

version string

Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.

key str

Name of the environment variable.

project str

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 str

Name of the secret in secret manager (not the full resource name).

version str

Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.

key String

Name of the environment variable.

project 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).

version String

Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.

SecretVersionResponse

Path string

Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as /secret_foo would mount the secret value file at /etc/secrets/secret_foo.

Version string

Version of the secret (version number or the string 'latest'). It is preferrable to use latest version with secret volumes as secret value changes are reflected immediately.

Path string

Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as /secret_foo would mount the secret value file at /etc/secrets/secret_foo.

Version string

Version of the secret (version number or the string 'latest'). It is preferrable to use latest version with secret volumes as secret value changes are reflected immediately.

path String

Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as /secret_foo would mount the secret value file at /etc/secrets/secret_foo.

version String

Version of the secret (version number or the string 'latest'). It is preferrable to use latest version with secret volumes as secret value changes are reflected immediately.

path string

Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as /secret_foo would mount the secret value file at /etc/secrets/secret_foo.

version string

Version of the secret (version number or the string 'latest'). It is preferrable to use latest version with secret volumes as secret value changes are reflected immediately.

path str

Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as /secret_foo would mount the secret value file at /etc/secrets/secret_foo.

version str

Version of the secret (version number or the string 'latest'). It is preferrable to use latest version with secret volumes as secret value changes are reflected immediately.

path String

Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as /secret_foo would mount the secret value file at /etc/secrets/secret_foo.

version String

Version of the secret (version number or the string 'latest'). It is preferrable to use latest version with secret volumes as secret value changes are reflected immediately.

SecretVolumeResponse

MountPath 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 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 List<Pulumi.GoogleNative.CloudFunctions.V1.Inputs.SecretVersionResponse>

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.

MountPath 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 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 []SecretVersionResponse

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.

mountPath 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 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 List<SecretVersionResponse>

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.

mountPath 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 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 SecretVersionResponse[]

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.

mount_path str

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 str

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 str

Name of the secret in secret manager (not the full resource name).

versions Sequence[SecretVersionResponse]

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.

mountPath 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 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 List<Property Map>

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.

SourceRepositoryResponse

DeployedUrl string

The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.

Url string

The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/* To refer to a moveable alias (branch): https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/* In particular, to refer to HEAD use master moveable alias. To refer to a specific fixed alias (tag): https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/* You may omit paths/* if you want to use the main directory.

DeployedUrl string

The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.

Url string

The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/* To refer to a moveable alias (branch): https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/* In particular, to refer to HEAD use master moveable alias. To refer to a specific fixed alias (tag): https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/* You may omit paths/* if you want to use the main directory.

deployedUrl String

The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.

url String

The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/* To refer to a moveable alias (branch): https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/* In particular, to refer to HEAD use master moveable alias. To refer to a specific fixed alias (tag): https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/* You may omit paths/* if you want to use the main directory.

deployedUrl string

The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.

url string

The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/* To refer to a moveable alias (branch): https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/* In particular, to refer to HEAD use master moveable alias. To refer to a specific fixed alias (tag): https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/* You may omit paths/* if you want to use the main directory.

deployed_url str

The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.

url str

The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/* To refer to a moveable alias (branch): https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/* In particular, to refer to HEAD use master moveable alias. To refer to a specific fixed alias (tag): https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/* You may omit paths/* if you want to use the main directory.

deployedUrl String

The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.

url String

The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/* To refer to a moveable alias (branch): https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/* In particular, to refer to HEAD use master moveable alias. To refer to a specific fixed alias (tag): https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/* You may omit paths/* if you want to use the main directory.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0