Google Cloud Classic v7.19.0, Apr 18 24

Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi

gcp.cloudfunctionsv2.getFunction

Explore with Pulumi AI

Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const my-function = gcp.cloudfunctionsv2.getFunction({
    name: "function",
    location: "us-central1",
});

import pulumi
import pulumi_gcp as gcp

my_function = gcp.cloudfunctionsv2.get_function(name="function",
    location="us-central1")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/cloudfunctionsv2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfunctionsv2.LookupFunction(ctx, &cloudfunctionsv2.LookupFunctionArgs{
			Name:     "function",
			Location: "us-central1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var my_function = Gcp.CloudFunctionsV2.GetFunction.Invoke(new()
    {
        Name = "function",
        Location = "us-central1",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudfunctionsv2.Cloudfunctionsv2Functions;
import com.pulumi.gcp.cloudfunctionsv2.inputs.GetFunctionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var my-function = Cloudfunctionsv2Functions.getFunction(GetFunctionArgs.builder()
            .name("function")
            .location("us-central1")
            .build());

    }
}

variables:
  my-function:
    fn::invoke:
      Function: gcp:cloudfunctionsv2:getFunction
      Arguments:
        name: function
        location: us-central1

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(location: Optional[str] = None,
                 name: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFunctionResult
def get_function_output(location: Optional[pulumi.Input[str]] = None,
                 name: 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: gcp:cloudfunctionsv2/getFunction:getFunction
  arguments:
    # arguments dictionary

The following arguments are supported:

Location string: The location in which the resource belongs.
Name string: The name of a Cloud Function (2nd gen).
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.

Location string: The location in which the resource belongs.
Name string: The name of a Cloud Function (2nd gen).
Project string: The project in which the resource belongs. If it is not provided, the provider project is used.

location String: The location in which the resource belongs.
name String: The name of a Cloud Function (2nd gen).
project String: The project in which the resource belongs. If it is not provided, the provider project is used.

location string: The location in which the resource belongs.
name string: The name of a Cloud Function (2nd gen).
project string: The project in which the resource belongs. If it is not provided, the provider project is used.

location str: The location in which the resource belongs.
name str: The name of a Cloud Function (2nd gen).
project str: The project in which the resource belongs. If it is not provided, the provider project is used.

location String: The location in which the resource belongs.
name String: The name of a Cloud Function (2nd gen).
project String: The project in which the resource belongs. If it is not provided, the provider project is used.

getFunction Result

The following output properties are available:

BuildConfigs List<GetFunctionBuildConfig>
Description string
EffectiveLabels Dictionary<string, string>
Environment string
EventTriggers List<GetFunctionEventTrigger>
Id string: The provider-assigned unique ID for this managed resource.
KmsKeyName string
Labels Dictionary<string, string>
Location string
Name string
PulumiLabels Dictionary<string, string>
ServiceConfigs List<GetFunctionServiceConfig>
State string
UpdateTime string
Url string
Project string

BuildConfigs []GetFunctionBuildConfig
Description string
EffectiveLabels map[string]string
Environment string
EventTriggers []GetFunctionEventTrigger
Id string: The provider-assigned unique ID for this managed resource.
KmsKeyName string
Labels map[string]string
Location string
Name string
PulumiLabels map[string]string
ServiceConfigs []GetFunctionServiceConfig
State string
UpdateTime string
Url string
Project string

buildConfigs List<GetFunctionBuildConfig>
description String
effectiveLabels Map<String,String>
environment String
eventTriggers List<GetFunctionEventTrigger>
id String: The provider-assigned unique ID for this managed resource.
kmsKeyName String
labels Map<String,String>
location String
name String
pulumiLabels Map<String,String>
serviceConfigs List<GetFunctionServiceConfig>
state String
updateTime String
url String
project String

buildConfigs GetFunctionBuildConfig[]
description string
effectiveLabels {[key: string]: string}
environment string
eventTriggers GetFunctionEventTrigger[]
id string: The provider-assigned unique ID for this managed resource.
kmsKeyName string
labels {[key: string]: string}
location string
name string
pulumiLabels {[key: string]: string}
serviceConfigs GetFunctionServiceConfig[]
state string
updateTime string
url string
project string

build_configs Sequence[GetFunctionBuildConfig]
description str
effective_labels Mapping[str, str]
environment str
event_triggers Sequence[GetFunctionEventTrigger]
id str: The provider-assigned unique ID for this managed resource.
kms_key_name str
labels Mapping[str, str]
location str
name str
pulumi_labels Mapping[str, str]
service_configs Sequence[GetFunctionServiceConfig]
state str
update_time str
url str
project str

buildConfigs List<Property Map>
description String
effectiveLabels Map<String>
environment String
eventTriggers List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
kmsKeyName String
labels Map<String>
location String
name String
pulumiLabels Map<String>
serviceConfigs List<Property Map>
state String
updateTime String
url String
project String

Supporting Types

GetFunctionBuildConfig

Build string: The Cloud Build name of the latest successful deployment of the function.
DockerRepository string: User managed repository created in Artifact Registry optionally with a customer managed encryption key.
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>: User-provided build-time environment variables for the function.
Runtime string: The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function.
Sources List<GetFunctionBuildConfigSource>: The location of the function source code.
WorkerPool string: Name of the Cloud Build Custom Worker Pool that should be used to build the function.

Build string: The Cloud Build name of the latest successful deployment of the function.
DockerRepository string: User managed repository created in Artifact Registry optionally with a customer managed encryption key.
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: User-provided build-time environment variables for the function.
Runtime string: The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function.
Sources []GetFunctionBuildConfigSource: The location of the function source code.
WorkerPool string: Name of the Cloud Build Custom Worker Pool that should be used to build the function.

build String: The Cloud Build name of the latest successful deployment of the function.
dockerRepository String: User managed repository created in Artifact Registry optionally with a customer managed encryption key.
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>: User-provided build-time environment variables for the function.
runtime String: The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function.
sources List<GetFunctionBuildConfigSource>: The location of the function source code.
workerPool String: Name of the Cloud Build Custom Worker Pool that should be used to build the function.

build string: The Cloud Build name of the latest successful deployment of the function.
dockerRepository string: User managed repository created in Artifact Registry optionally with a customer managed encryption key.
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}: User-provided build-time environment variables for the function.
runtime string: The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function.
sources GetFunctionBuildConfigSource[]: The location of the function source code.
workerPool string: Name of the Cloud Build Custom Worker Pool that should be used to build the function.

build str: The Cloud Build name of the latest successful deployment of the function.
docker_repository str: User managed repository created in Artifact Registry optionally with a customer managed encryption key.
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]: User-provided build-time environment variables for the function.
runtime str: The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function.
sources Sequence[GetFunctionBuildConfigSource]: The location of the function source code.
worker_pool str: Name of the Cloud Build Custom Worker Pool that should be used to build the function.

build String: The Cloud Build name of the latest successful deployment of the function.
dockerRepository String: User managed repository created in Artifact Registry optionally with a customer managed encryption key.
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>: User-provided build-time environment variables for the function.
runtime String: The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function.
sources List<Property Map>: The location of the function source code.
workerPool String: Name of the Cloud Build Custom Worker Pool that should be used to build the function.

GetFunctionBuildConfigSource

RepoSources List<GetFunctionBuildConfigSourceRepoSource>: If provided, get the source from this location in a Cloud Source Repository.
StorageSources List<GetFunctionBuildConfigSourceStorageSource>: If provided, get the source from this location in Google Cloud Storage.

RepoSources []GetFunctionBuildConfigSourceRepoSource: If provided, get the source from this location in a Cloud Source Repository.
StorageSources []GetFunctionBuildConfigSourceStorageSource: If provided, get the source from this location in Google Cloud Storage.

repoSources List<GetFunctionBuildConfigSourceRepoSource>: If provided, get the source from this location in a Cloud Source Repository.
storageSources List<GetFunctionBuildConfigSourceStorageSource>: If provided, get the source from this location in Google Cloud Storage.

repoSources GetFunctionBuildConfigSourceRepoSource[]: If provided, get the source from this location in a Cloud Source Repository.
storageSources GetFunctionBuildConfigSourceStorageSource[]: If provided, get the source from this location in Google Cloud Storage.

repo_sources Sequence[GetFunctionBuildConfigSourceRepoSource]: If provided, get the source from this location in a Cloud Source Repository.
storage_sources Sequence[GetFunctionBuildConfigSourceStorageSource]: If provided, get the source from this location in Google Cloud Storage.

repoSources List<Property Map>: If provided, get the source from this location in a Cloud Source Repository.
storageSources List<Property Map>: If provided, get the source from this location in Google Cloud Storage.

GetFunctionBuildConfigSourceRepoSource

BranchName string: Regex matching branches to build.
CommitSha string: Regex matching tags to build.
Dir string: Directory, relative to the source root, in which to run the build.
InvertRegex bool: Only trigger a build if the revision regex does NOT match the revision regex.
ProjectId string: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
RepoName string: Name of the Cloud Source Repository.
TagName string: Regex matching tags to build.

BranchName string: Regex matching branches to build.
CommitSha string: Regex matching tags to build.
Dir string: Directory, relative to the source root, in which to run the build.
InvertRegex bool: Only trigger a build if the revision regex does NOT match the revision regex.
ProjectId string: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
RepoName string: Name of the Cloud Source Repository.
TagName string: Regex matching tags to build.

branchName String: Regex matching branches to build.
commitSha String: Regex matching tags to build.
dir String: Directory, relative to the source root, in which to run the build.
invertRegex Boolean: Only trigger a build if the revision regex does NOT match the revision regex.
projectId String: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
repoName String: Name of the Cloud Source Repository.
tagName String: Regex matching tags to build.

branchName string: Regex matching branches to build.
commitSha string: Regex matching tags to build.
dir string: Directory, relative to the source root, in which to run the build.
invertRegex boolean: Only trigger a build if the revision regex does NOT match the revision regex.
projectId string: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
repoName string: Name of the Cloud Source Repository.
tagName string: Regex matching tags to build.

branch_name str: Regex matching branches to build.
commit_sha str: Regex matching tags to build.
dir str: Directory, relative to the source root, in which to run the build.
invert_regex bool: Only trigger a build if the revision regex does NOT match the revision regex.
project_id str: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
repo_name str: Name of the Cloud Source Repository.
tag_name str: Regex matching tags to build.

branchName String: Regex matching branches to build.
commitSha String: Regex matching tags to build.
dir String: Directory, relative to the source root, in which to run the build.
invertRegex Boolean: Only trigger a build if the revision regex does NOT match the revision regex.
projectId String: ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
repoName String: Name of the Cloud Source Repository.
tagName String: Regex matching tags to build.

GetFunctionBuildConfigSourceStorageSource

Bucket string: Google Cloud Storage bucket containing the source
Generation int: Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
Object string: Google Cloud Storage object containing the source.

Bucket string: Google Cloud Storage bucket containing the source
Generation int: Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
Object string: Google Cloud Storage object containing the source.

bucket String: Google Cloud Storage bucket containing the source
generation Integer: Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
object String: Google Cloud Storage object containing the source.

bucket string: Google Cloud Storage bucket containing the source
generation number: Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
object string: Google Cloud Storage object containing the source.

bucket str: Google Cloud Storage bucket containing the source
generation int: Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
object str: Google Cloud Storage object containing the source.

bucket String: Google Cloud Storage bucket containing the source
generation Number: Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
object String: Google Cloud Storage object containing the source.

GetFunctionEventTrigger

EventFilters List<GetFunctionEventTriggerEventFilter>: Criteria used to filter events.
EventType string: Required. The type of event to observe.
PubsubTopic string: The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery.
RetryPolicy string: Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution. Possible values: ["RETRY_POLICY_UNSPECIFIED", "RETRY_POLICY_DO_NOT_RETRY", "RETRY_POLICY_RETRY"]
ServiceAccountEmail string: Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services. If empty, defaults to the Compute Engine default service account: {project_number}-compute@developer.gserviceaccount.com.
Trigger string: Output only. The resource name of the Eventarc trigger.
TriggerRegion string: The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.

EventFilters []GetFunctionEventTriggerEventFilter: Criteria used to filter events.
EventType string: Required. The type of event to observe.
PubsubTopic string: The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery.
RetryPolicy string: Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution. Possible values: ["RETRY_POLICY_UNSPECIFIED", "RETRY_POLICY_DO_NOT_RETRY", "RETRY_POLICY_RETRY"]
ServiceAccountEmail string: Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services. If empty, defaults to the Compute Engine default service account: {project_number}-compute@developer.gserviceaccount.com.
Trigger string: Output only. The resource name of the Eventarc trigger.
TriggerRegion string: The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.

eventFilters List<GetFunctionEventTriggerEventFilter>: Criteria used to filter events.
eventType String: Required. The type of event to observe.
pubsubTopic String: The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery.
retryPolicy String: Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution. Possible values: ["RETRY_POLICY_UNSPECIFIED", "RETRY_POLICY_DO_NOT_RETRY", "RETRY_POLICY_RETRY"]
serviceAccountEmail String: Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services. If empty, defaults to the Compute Engine default service account: {project_number}-compute@developer.gserviceaccount.com.
trigger String: Output only. The resource name of the Eventarc trigger.
triggerRegion String: The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.

eventFilters GetFunctionEventTriggerEventFilter[]: Criteria used to filter events.
eventType string: Required. The type of event to observe.
pubsubTopic string: The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery.
retryPolicy string: Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution. Possible values: ["RETRY_POLICY_UNSPECIFIED", "RETRY_POLICY_DO_NOT_RETRY", "RETRY_POLICY_RETRY"]
serviceAccountEmail string: Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services. If empty, defaults to the Compute Engine default service account: {project_number}-compute@developer.gserviceaccount.com.
trigger string: Output only. The resource name of the Eventarc trigger.
triggerRegion string: The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.

event_filters Sequence[GetFunctionEventTriggerEventFilter]: Criteria used to filter events.
event_type str: Required. The type of event to observe.
pubsub_topic str: The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery.
retry_policy str: Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution. Possible values: ["RETRY_POLICY_UNSPECIFIED", "RETRY_POLICY_DO_NOT_RETRY", "RETRY_POLICY_RETRY"]
service_account_email str: Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services. If empty, defaults to the Compute Engine default service account: {project_number}-compute@developer.gserviceaccount.com.
trigger str: Output only. The resource name of the Eventarc trigger.
trigger_region str: The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.

eventFilters List<Property Map>: Criteria used to filter events.
eventType String: Required. The type of event to observe.
pubsubTopic String: The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery.
retryPolicy String: Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution. Possible values: ["RETRY_POLICY_UNSPECIFIED", "RETRY_POLICY_DO_NOT_RETRY", "RETRY_POLICY_RETRY"]
serviceAccountEmail String: Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services. If empty, defaults to the Compute Engine default service account: {project_number}-compute@developer.gserviceaccount.com.
trigger String: Output only. The resource name of the Eventarc trigger.
triggerRegion String: The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.

GetFunctionEventTriggerEventFilter

Attribute string: 'Required. The name of a CloudEvents attribute. Currently, only a subset of attributes are supported for filtering. Use the 'gcloud eventarc providers describe' command to learn more about events and their attributes. Do not filter for the 'type' attribute here, as this is already achieved by the resource's 'event_type' attribute.
Operator string: Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is 'match-path-pattern'. See documentation on path patterns here'
Value string: Required. The value for the attribute. If the operator field is set as 'match-path-pattern', this value can be a path pattern instead of an exact value.

Attribute string: 'Required. The name of a CloudEvents attribute. Currently, only a subset of attributes are supported for filtering. Use the 'gcloud eventarc providers describe' command to learn more about events and their attributes. Do not filter for the 'type' attribute here, as this is already achieved by the resource's 'event_type' attribute.
Operator string: Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is 'match-path-pattern'. See documentation on path patterns here'
Value string: Required. The value for the attribute. If the operator field is set as 'match-path-pattern', this value can be a path pattern instead of an exact value.

attribute String: 'Required. The name of a CloudEvents attribute. Currently, only a subset of attributes are supported for filtering. Use the 'gcloud eventarc providers describe' command to learn more about events and their attributes. Do not filter for the 'type' attribute here, as this is already achieved by the resource's 'event_type' attribute.
operator String: Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is 'match-path-pattern'. See documentation on path patterns here'
value String: Required. The value for the attribute. If the operator field is set as 'match-path-pattern', this value can be a path pattern instead of an exact value.

attribute string: 'Required. The name of a CloudEvents attribute. Currently, only a subset of attributes are supported for filtering. Use the 'gcloud eventarc providers describe' command to learn more about events and their attributes. Do not filter for the 'type' attribute here, as this is already achieved by the resource's 'event_type' attribute.
operator string: Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is 'match-path-pattern'. See documentation on path patterns here'
value string: Required. The value for the attribute. If the operator field is set as 'match-path-pattern', this value can be a path pattern instead of an exact value.

attribute str: 'Required. The name of a CloudEvents attribute. Currently, only a subset of attributes are supported for filtering. Use the 'gcloud eventarc providers describe' command to learn more about events and their attributes. Do not filter for the 'type' attribute here, as this is already achieved by the resource's 'event_type' attribute.
operator str: Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is 'match-path-pattern'. See documentation on path patterns here'
value str: Required. The value for the attribute. If the operator field is set as 'match-path-pattern', this value can be a path pattern instead of an exact value.

attribute String: 'Required. The name of a CloudEvents attribute. Currently, only a subset of attributes are supported for filtering. Use the 'gcloud eventarc providers describe' command to learn more about events and their attributes. Do not filter for the 'type' attribute here, as this is already achieved by the resource's 'event_type' attribute.
operator String: Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is 'match-path-pattern'. See documentation on path patterns here'
value String: Required. The value for the attribute. If the operator field is set as 'match-path-pattern', this value can be a path pattern instead of an exact value.

GetFunctionServiceConfig

AllTrafficOnLatestRevision bool: Whether 100% of traffic is routed to the latest revision. Defaults to true.
AvailableCpu string: The number of CPUs used in a single container instance. Default value is calculated from available memory.
AvailableMemory string: The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes.
EnvironmentVariables Dictionary<string, string>: Environment variables that shall be available during function execution.
GcfUri string: URIs of the Service deployed
IngressSettings string: Available ingress settings. Defaults to "ALLOW_ALL" if unspecified. Default value: "ALLOW_ALL" Possible values: ["ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
MaxInstanceCount int: The limit on the maximum number of function instances that may coexist at a given time.
MaxInstanceRequestConcurrency int: Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
MinInstanceCount int: The limit on the minimum number of function instances that may coexist at a given time.
SecretEnvironmentVariables List<GetFunctionServiceConfigSecretEnvironmentVariable>: Secret environment variables configuration.
SecretVolumes List<GetFunctionServiceConfigSecretVolume>: Secret volumes configuration.
Service string: Name of the service associated with a Function.
ServiceAccountEmail string: The email of the service account for this function.
TimeoutSeconds int: 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.
Uri string: URI of the Service deployed.
VpcConnector string: The Serverless VPC Access connector that this cloud function can connect to.
VpcConnectorEgressSettings string: Available egress settings. Possible values: ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]

AllTrafficOnLatestRevision bool: Whether 100% of traffic is routed to the latest revision. Defaults to true.
AvailableCpu string: The number of CPUs used in a single container instance. Default value is calculated from available memory.
AvailableMemory string: The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes.
EnvironmentVariables map[string]string: Environment variables that shall be available during function execution.
GcfUri string: URIs of the Service deployed
IngressSettings string: Available ingress settings. Defaults to "ALLOW_ALL" if unspecified. Default value: "ALLOW_ALL" Possible values: ["ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
MaxInstanceCount int: The limit on the maximum number of function instances that may coexist at a given time.
MaxInstanceRequestConcurrency int: Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
MinInstanceCount int: The limit on the minimum number of function instances that may coexist at a given time.
SecretEnvironmentVariables []GetFunctionServiceConfigSecretEnvironmentVariable: Secret environment variables configuration.
SecretVolumes []GetFunctionServiceConfigSecretVolume: Secret volumes configuration.
Service string: Name of the service associated with a Function.
ServiceAccountEmail string: The email of the service account for this function.
TimeoutSeconds int: 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.
Uri string: URI of the Service deployed.
VpcConnector string: The Serverless VPC Access connector that this cloud function can connect to.
VpcConnectorEgressSettings string: Available egress settings. Possible values: ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]

allTrafficOnLatestRevision Boolean: Whether 100% of traffic is routed to the latest revision. Defaults to true.
availableCpu String: The number of CPUs used in a single container instance. Default value is calculated from available memory.
availableMemory String: The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes.
environmentVariables Map<String,String>: Environment variables that shall be available during function execution.
gcfUri String: URIs of the Service deployed
ingressSettings String: Available ingress settings. Defaults to "ALLOW_ALL" if unspecified. Default value: "ALLOW_ALL" Possible values: ["ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
maxInstanceCount Integer: The limit on the maximum number of function instances that may coexist at a given time.
maxInstanceRequestConcurrency Integer: Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
minInstanceCount Integer: The limit on the minimum number of function instances that may coexist at a given time.
secretEnvironmentVariables List<GetFunctionServiceConfigSecretEnvironmentVariable>: Secret environment variables configuration.
secretVolumes List<GetFunctionServiceConfigSecretVolume>: Secret volumes configuration.
service String: Name of the service associated with a Function.
serviceAccountEmail String: The email of the service account for this function.
timeoutSeconds Integer: 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.
uri String: URI of the Service deployed.
vpcConnector String: The Serverless VPC Access connector that this cloud function can connect to.
vpcConnectorEgressSettings String: Available egress settings. Possible values: ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]

allTrafficOnLatestRevision boolean: Whether 100% of traffic is routed to the latest revision. Defaults to true.
availableCpu string: The number of CPUs used in a single container instance. Default value is calculated from available memory.
availableMemory string: The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes.
environmentVariables {[key: string]: string}: Environment variables that shall be available during function execution.
gcfUri string: URIs of the Service deployed
ingressSettings string: Available ingress settings. Defaults to "ALLOW_ALL" if unspecified. Default value: "ALLOW_ALL" Possible values: ["ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
maxInstanceCount number: The limit on the maximum number of function instances that may coexist at a given time.
maxInstanceRequestConcurrency number: Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
minInstanceCount number: The limit on the minimum number of function instances that may coexist at a given time.
secretEnvironmentVariables GetFunctionServiceConfigSecretEnvironmentVariable[]: Secret environment variables configuration.
secretVolumes GetFunctionServiceConfigSecretVolume[]: Secret volumes configuration.
service string: Name of the service associated with a Function.
serviceAccountEmail string: The email of the service account for this function.
timeoutSeconds number: 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.
uri string: URI of the Service deployed.
vpcConnector string: The Serverless VPC Access connector that this cloud function can connect to.
vpcConnectorEgressSettings string: Available egress settings. Possible values: ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]

all_traffic_on_latest_revision bool: Whether 100% of traffic is routed to the latest revision. Defaults to true.
available_cpu str: The number of CPUs used in a single container instance. Default value is calculated from available memory.
available_memory str: The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes.
environment_variables Mapping[str, str]: Environment variables that shall be available during function execution.
gcf_uri str: URIs of the Service deployed
ingress_settings str: Available ingress settings. Defaults to "ALLOW_ALL" if unspecified. Default value: "ALLOW_ALL" Possible values: ["ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
max_instance_count int: The limit on the maximum number of function instances that may coexist at a given time.
max_instance_request_concurrency int: Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
min_instance_count int: The limit on the minimum number of function instances that may coexist at a given time.
secret_environment_variables Sequence[GetFunctionServiceConfigSecretEnvironmentVariable]: Secret environment variables configuration.
secret_volumes Sequence[GetFunctionServiceConfigSecretVolume]: Secret volumes configuration.
service str: Name of the service associated with a Function.
service_account_email str: The email of the service account for this function.
timeout_seconds int: 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.
uri str: URI of the Service deployed.
vpc_connector str: The Serverless VPC Access connector that this cloud function can connect to.
vpc_connector_egress_settings str: Available egress settings. Possible values: ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]

allTrafficOnLatestRevision Boolean: Whether 100% of traffic is routed to the latest revision. Defaults to true.
availableCpu String: The number of CPUs used in a single container instance. Default value is calculated from available memory.
availableMemory String: The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes.
environmentVariables Map<String>: Environment variables that shall be available during function execution.
gcfUri String: URIs of the Service deployed
ingressSettings String: Available ingress settings. Defaults to "ALLOW_ALL" if unspecified. Default value: "ALLOW_ALL" Possible values: ["ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"]
maxInstanceCount Number: The limit on the maximum number of function instances that may coexist at a given time.
maxInstanceRequestConcurrency Number: Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
minInstanceCount Number: The limit on the minimum number of function instances that may coexist at a given time.
secretEnvironmentVariables List<Property Map>: Secret environment variables configuration.
secretVolumes List<Property Map>: Secret volumes configuration.
service String: Name of the service associated with a Function.
serviceAccountEmail String: The email of the service account for this function.
timeoutSeconds Number: 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.
uri String: URI of the Service deployed.
vpcConnector String: The Serverless VPC Access connector that this cloud function can connect to.
vpcConnectorEgressSettings String: Available egress settings. Possible values: ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"]

GetFunctionServiceConfigSecretEnvironmentVariable

Key string: Name of the environment variable.
ProjectId 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.
ProjectId 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.
projectId 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.
projectId 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_id 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.
projectId 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.

GetFunctionServiceConfigSecretVolume

MountPath string: The path within the container to mount the secret volume. For example, setting the mountPath 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
ProjectId 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<GetFunctionServiceConfigSecretVolumeVersion>: 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 mountPath 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
ProjectId 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 []GetFunctionServiceConfigSecretVolumeVersion: 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 mountPath 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
projectId 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<GetFunctionServiceConfigSecretVolumeVersion>: 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 mountPath 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
projectId 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 GetFunctionServiceConfigSecretVolumeVersion[]: 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 mountPath 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
project_id 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[GetFunctionServiceConfigSecretVolumeVersion]: 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 mountPath 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
projectId 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.'

GetFunctionServiceConfigSecretVolumeVersion

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 mountPath 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 preferable 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 mountPath 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 preferable 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 mountPath 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 preferable 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 mountPath 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 preferable 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 mountPath 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 preferable 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 mountPath 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 preferable to use latest version with secret volumes as secret value changes are reflected immediately.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud Classic v7.19.0 published on Thursday, Apr 18, 2024 by Pulumi

pulumi/pulumi-gcp

gcp.cloudfunctionsv2.getFunction

On this page

On this page

Example Usage

Using getFunction

getFunction Result

Supporting Types

GetFunctionBuildConfig

GetFunctionBuildConfigSource

GetFunctionBuildConfigSourceRepoSource

GetFunctionBuildConfigSourceStorageSource

GetFunctionEventTrigger

GetFunctionEventTriggerEventFilter

GetFunctionServiceConfig

GetFunctionServiceConfigSecretEnvironmentVariable

GetFunctionServiceConfigSecretVolume

GetFunctionServiceConfigSecretVolumeVersion

Package Details

On this page

On this page