import * as pulumi from "@pulumi/pulumi"; import { input as inputs, output as outputs } from "../../types"; /** * Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error. */ export declare class Function extends pulumi.CustomResource { /** * Get an existing Function resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, opts?: pulumi.CustomResourceOptions): Function; /** * Returns true if the given object is an instance of Function. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Function; /** * The amount of memory in MB available for a function. Defaults to 256MB. */ readonly availableMemoryMb: pulumi.Output; /** * Build environment variables that shall be available during build time. */ readonly buildEnvironmentVariables: pulumi.Output<{ [key: string]: string; }>; /** * The Cloud Build ID of the latest successful deployment of the function. */ readonly buildId: pulumi.Output; /** * 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. */ readonly buildWorkerPool: pulumi.Output; /** * User-provided description of a function. */ readonly description: pulumi.Output; /** * 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`. */ readonly entryPoint: pulumi.Output; /** * Environment variables that shall be available during function execution. */ readonly environmentVariables: pulumi.Output<{ [key: string]: string; }>; /** * A source that fires events in response to a condition in another service. */ readonly eventTrigger: pulumi.Output; /** * An HTTPS endpoint type of source that can be triggered via URL. */ readonly httpsTrigger: pulumi.Output; /** * The ingress settings for the function, controlling what traffic can reach it. */ readonly ingressSettings: pulumi.Output; /** * Labels associated with this Cloud Function. */ readonly labels: pulumi.Output<{ [key: string]: string; }>; /** * 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](https://cloud.google.com/functions/docs/max-instances) Guide for more details. */ readonly maxInstances: pulumi.Output; /** * A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*` */ readonly name: pulumi.Output; /** * 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](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. */ readonly network: pulumi.Output; /** * 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](/sdk/gcloud/reference/functions/deploy#--runtime). */ readonly runtime: pulumi.Output; /** * The email of the function's service account. If empty, defaults to `{project_id}@appspot.gserviceaccount.com`. */ readonly serviceAccountEmail: pulumi.Output; /** * The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. */ readonly sourceArchiveUrl: pulumi.Output; /** * **Beta Feature** The source repository where a function is hosted. */ readonly sourceRepository: pulumi.Output; /** * Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. */ readonly sourceToken: pulumi.Output; /** * The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1.GenerateUploadUrl */ readonly sourceUploadUrl: pulumi.Output; /** * Status of the function deployment. */ readonly status: pulumi.Output; /** * 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. */ readonly timeout: pulumi.Output; /** * The last update timestamp of a Cloud Function. */ readonly updateTime: pulumi.Output; /** * The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created. */ readonly versionId: pulumi.Output; /** * 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](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. */ readonly vpcConnector: pulumi.Output; /** * The egress settings for the connector, controlling what traffic is diverted through it. */ readonly vpcConnectorEgressSettings: pulumi.Output; /** * Create a Function resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: FunctionArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Function resource. */ export interface FunctionArgs { /** * The amount of memory in MB available for a function. Defaults to 256MB. */ readonly availableMemoryMb?: pulumi.Input; /** * Build environment variables that shall be available during build time. */ readonly buildEnvironmentVariables?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * 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. */ readonly buildWorkerPool?: pulumi.Input; /** * User-provided description of a function. */ readonly description?: pulumi.Input; /** * 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`. */ readonly entryPoint?: pulumi.Input; /** * Environment variables that shall be available during function execution. */ readonly environmentVariables?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A source that fires events in response to a condition in another service. */ readonly eventTrigger?: pulumi.Input; readonly functionsId: pulumi.Input; /** * An HTTPS endpoint type of source that can be triggered via URL. */ readonly httpsTrigger?: pulumi.Input; /** * The ingress settings for the function, controlling what traffic can reach it. */ readonly ingressSettings?: pulumi.Input; /** * Labels associated with this Cloud Function. */ readonly labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; readonly locationsId: pulumi.Input; /** * 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](https://cloud.google.com/functions/docs/max-instances) Guide for more details. */ readonly maxInstances?: pulumi.Input; /** * A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*` */ readonly name?: pulumi.Input; /** * 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](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. */ readonly network?: pulumi.Input; readonly projectsId: pulumi.Input; /** * 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](/sdk/gcloud/reference/functions/deploy#--runtime). */ readonly runtime?: pulumi.Input; /** * The email of the function's service account. If empty, defaults to `{project_id}@appspot.gserviceaccount.com`. */ readonly serviceAccountEmail?: pulumi.Input; /** * The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. */ readonly sourceArchiveUrl?: pulumi.Input; /** * **Beta Feature** The source repository where a function is hosted. */ readonly sourceRepository?: pulumi.Input; /** * Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. */ readonly sourceToken?: pulumi.Input; /** * The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1.GenerateUploadUrl */ readonly sourceUploadUrl?: pulumi.Input; /** * 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. */ readonly timeout?: pulumi.Input; /** * 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](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. */ readonly vpcConnector?: pulumi.Input; /** * The egress settings for the connector, controlling what traffic is diverted through it. */ readonly vpcConnectorEgressSettings?: pulumi.Input; }