Google Cloud Native v0.30.0, Apr 14 23
Google Cloud Native v0.30.0, Apr 14 23
google-native.cloudfunctions/v1.Function
Explore with Pulumi AI
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.
Create Function Resource
new Function(name: string, args?: FunctionArgs, opts?: CustomResourceOptions);
@overload
def Function(resource_name: str,
opts: Optional[ResourceOptions] = None,
available_memory_mb: Optional[int] = None,
build_environment_variables: Optional[Mapping[str, str]] = None,
build_worker_pool: Optional[str] = None,
description: Optional[str] = None,
docker_registry: Optional[FunctionDockerRegistry] = None,
docker_repository: Optional[str] = None,
entry_point: Optional[str] = None,
environment_variables: Optional[Mapping[str, str]] = None,
event_trigger: Optional[EventTriggerArgs] = None,
https_trigger: Optional[HttpsTriggerArgs] = None,
ingress_settings: Optional[FunctionIngressSettings] = None,
kms_key_name: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
location: Optional[str] = None,
max_instances: Optional[int] = None,
min_instances: Optional[int] = None,
name: Optional[str] = None,
network: Optional[str] = None,
project: Optional[str] = None,
runtime: Optional[str] = None,
secret_environment_variables: Optional[Sequence[SecretEnvVarArgs]] = None,
secret_volumes: Optional[Sequence[SecretVolumeArgs]] = None,
service_account_email: Optional[str] = None,
source_archive_url: Optional[str] = None,
source_repository: Optional[SourceRepositoryArgs] = None,
source_token: Optional[str] = None,
source_upload_url: Optional[str] = None,
timeout: Optional[str] = None,
vpc_connector: Optional[str] = None,
vpc_connector_egress_settings: Optional[FunctionVpcConnectorEgressSettings] = None)
@overload
def Function(resource_name: str,
args: Optional[FunctionArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewFunction(ctx *Context, name string, args *FunctionArgs, opts ...ResourceOption) (*Function, error)
public Function(string name, FunctionArgs? args = null, CustomResourceOptions? opts = null)
public Function(String name, FunctionArgs args)
public Function(String name, FunctionArgs args, CustomResourceOptions options)
type: google-native:cloudfunctions/v1:Function
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FunctionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FunctionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FunctionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FunctionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FunctionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Function Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Function resource accepts the following input properties:
- Available
Memory intMb The amount of memory in MB available for a function. Defaults to 256MB.
- Build
Environment Dictionary<string, string>Variables Build environment variables that shall be available during build time.
- Build
Worker stringPool 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.
- Docker
Registry Pulumi.Google Native. Cloud Functions. V1. Function Docker Registry Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_REGISTRY
. This field may be overridden by the backend for eligible deployments.- Docker
Repository 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'.- Entry
Point 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
.- Environment
Variables Dictionary<string, string> Environment variables that shall be available during function execution.
- Event
Trigger Pulumi.Google Native. Cloud Functions. V1. Inputs. Event Trigger Args A source that fires events in response to a condition in another service.
- Https
Trigger Pulumi.Google Native. Cloud Functions. V1. Inputs. Https Trigger Args An HTTPS endpoint type of source that can be triggered via URL.
- Ingress
Settings Pulumi.Google Native. Cloud Functions. V1. Function Ingress Settings The ingress settings for the function, controlling what traffic can reach it.
- Kms
Key stringName 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 thedocker_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.
- Location string
- 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 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 withvpc_connector
and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.- Project string
- 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.- Secret
Environment List<Pulumi.Variables Google Native. Cloud Functions. V1. Inputs. Secret Env Var Args> Secret environment variables configuration.
- Secret
Volumes List<Pulumi.Google Native. Cloud Functions. V1. Inputs. Secret Volume Args> Secret volumes configuration.
- Service
Account stringEmail The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
.- Source
Archive stringUrl The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function.- Source
Repository Pulumi.Google Native. Cloud Functions. V1. Inputs. Source Repository Args Beta Feature The source repository where a function is hosted.
- Source
Token string Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- Source
Upload stringUrl 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)
- 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.
- Vpc
Connector 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 withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.- Vpc
Connector Pulumi.Egress Settings Google Native. Cloud Functions. V1. Function Vpc Connector Egress Settings The egress settings for the connector, controlling what traffic is diverted through it.
- Available
Memory intMb The amount of memory in MB available for a function. Defaults to 256MB.
- Build
Environment map[string]stringVariables Build environment variables that shall be available during build time.
- Build
Worker stringPool 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.
- Docker
Registry FunctionDocker Registry Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_REGISTRY
. This field may be overridden by the backend for eligible deployments.- Docker
Repository 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'.- Entry
Point 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
.- Environment
Variables map[string]string Environment variables that shall be available during function execution.
- Event
Trigger EventTrigger Args A source that fires events in response to a condition in another service.
- Https
Trigger HttpsTrigger Args An HTTPS endpoint type of source that can be triggered via URL.
- Ingress
Settings FunctionIngress Settings The ingress settings for the function, controlling what traffic can reach it.
- Kms
Key stringName 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 thedocker_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.
- Location string
- 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 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 withvpc_connector
and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.- Project string
- 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.- Secret
Environment []SecretVariables Env Var Args Secret environment variables configuration.
- Secret
Volumes []SecretVolume Args Secret volumes configuration.
- Service
Account stringEmail The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
.- Source
Archive stringUrl The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function.- Source
Repository SourceRepository Args Beta Feature The source repository where a function is hosted.
- Source
Token string Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- Source
Upload stringUrl 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)
- 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.
- Vpc
Connector 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 withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.- Vpc
Connector FunctionEgress Settings Vpc Connector Egress Settings The egress settings for the connector, controlling what traffic is diverted through it.
- available
Memory IntegerMb The amount of memory in MB available for a function. Defaults to 256MB.
- build
Environment Map<String,String>Variables Build environment variables that shall be available during build time.
- build
Worker StringPool 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.
- docker
Registry FunctionDocker Registry Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_REGISTRY
. This field may be overridden by the backend for eligible deployments.- docker
Repository 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'.- entry
Point 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
.- environment
Variables Map<String,String> Environment variables that shall be available during function execution.
- event
Trigger EventTrigger Args A source that fires events in response to a condition in another service.
- https
Trigger HttpsTrigger Args An HTTPS endpoint type of source that can be triggered via URL.
- ingress
Settings FunctionIngress Settings The ingress settings for the function, controlling what traffic can reach it.
- kms
Key StringName 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 thedocker_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.
- location String
- max
Instances 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.
- min
Instances 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 withvpc_connector
and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.- project String
- 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.- secret
Environment List<SecretVariables Env Var Args> Secret environment variables configuration.
- secret
Volumes List<SecretVolume Args> Secret volumes configuration.
- service
Account StringEmail The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
.- source
Archive StringUrl The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function.- source
Repository SourceRepository Args Beta Feature The source repository where a function is hosted.
- source
Token String Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- source
Upload StringUrl 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)
- 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.
- vpc
Connector 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 withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.- vpc
Connector FunctionEgress Settings Vpc Connector Egress Settings The egress settings for the connector, controlling what traffic is diverted through it.
- available
Memory numberMb The amount of memory in MB available for a function. Defaults to 256MB.
- build
Environment {[key: string]: string}Variables Build environment variables that shall be available during build time.
- build
Worker stringPool 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.
- docker
Registry FunctionDocker Registry Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_REGISTRY
. This field may be overridden by the backend for eligible deployments.- docker
Repository 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'.- entry
Point 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
.- environment
Variables {[key: string]: string} Environment variables that shall be available during function execution.
- event
Trigger EventTrigger Args A source that fires events in response to a condition in another service.
- https
Trigger HttpsTrigger Args An HTTPS endpoint type of source that can be triggered via URL.
- ingress
Settings FunctionIngress Settings The ingress settings for the function, controlling what traffic can reach it.
- kms
Key stringName 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 thedocker_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.
- location string
- max
Instances 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.
- min
Instances 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 withvpc_connector
and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.- project string
- 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.- secret
Environment SecretVariables Env Var Args[] Secret environment variables configuration.
- secret
Volumes SecretVolume Args[] Secret volumes configuration.
- service
Account stringEmail The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
.- source
Archive stringUrl The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function.- source
Repository SourceRepository Args Beta Feature The source repository where a function is hosted.
- source
Token string Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- source
Upload stringUrl 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)
- 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.
- vpc
Connector 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 withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.- vpc
Connector FunctionEgress Settings Vpc Connector Egress Settings The egress settings for the connector, controlling what traffic is diverted through it.
- available_
memory_ intmb The amount of memory in MB available for a function. Defaults to 256MB.
- build_
environment_ Mapping[str, str]variables Build environment variables that shall be available during build time.
- build_
worker_ strpool 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 FunctionDocker Registry Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_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 EventTrigger Args A source that fires events in response to a condition in another service.
- https_
trigger HttpsTrigger Args An HTTPS endpoint type of source that can be triggered via URL.
- ingress_
settings FunctionIngress Settings The ingress settings for the function, controlling what traffic can reach it.
- kms_
key_ strname 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 thedocker_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.
- location str
- 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 withvpc_connector
and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.- project str
- 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_ Sequence[Secretvariables Env Var Args] Secret environment variables configuration.
- secret_
volumes Sequence[SecretVolume Args] Secret volumes configuration.
- service_
account_ stremail The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
.- source_
archive_ strurl The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function.- source_
repository SourceRepository Args 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_ strurl 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)
- 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.
- 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 withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.- vpc_
connector_ Functionegress_ settings Vpc Connector Egress Settings The egress settings for the connector, controlling what traffic is diverted through it.
- available
Memory NumberMb The amount of memory in MB available for a function. Defaults to 256MB.
- build
Environment Map<String>Variables Build environment variables that shall be available during build time.
- build
Worker StringPool 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.
- docker
Registry "DOCKER_REGISTRY_UNSPECIFIED" | "CONTAINER_REGISTRY" | "ARTIFACT_REGISTRY" Docker Registry to use for this deployment. If
docker_repository
field is specified, this field will be automatically set asARTIFACT_REGISTRY
. If unspecified, it currently defaults toCONTAINER_REGISTRY
. This field may be overridden by the backend for eligible deployments.- docker
Repository 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'.- entry
Point 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
.- environment
Variables Map<String> Environment variables that shall be available during function execution.
- event
Trigger Property Map A source that fires events in response to a condition in another service.
- https
Trigger Property Map An HTTPS endpoint type of source that can be triggered via URL.
- ingress
Settings "INGRESS_SETTINGS_UNSPECIFIED" | "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB" The ingress settings for the function, controlling what traffic can reach it.
- kms
Key StringName 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 thedocker_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.
- location String
- max
Instances 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.
- min
Instances 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 withvpc_connector
and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.- project String
- 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.- secret
Environment List<Property Map>Variables Secret environment variables configuration.
- secret
Volumes List<Property Map> Secret volumes configuration.
- service
Account StringEmail The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com
.- source
Archive StringUrl The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function.- source
Repository Property Map Beta Feature The source repository where a function is hosted.
- source
Token String Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- source
Upload StringUrl 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)
- 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.
- vpc
Connector 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 withnetwork
field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.- vpc
Connector "VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED" | "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC"Egress Settings The egress settings for the connector, controlling what traffic is diverted through it.
Outputs
All input properties are implicitly available as output properties. Additionally, the Function resource produces the following output properties:
- Build
Id string The Cloud Build ID of the latest successful deployment of the function.
- Build
Name string The Cloud Build Name of the function deployment.
projects//locations//builds/
.- Id string
The provider-assigned unique ID for this managed resource.
- Status string
Status of the function deployment.
- Update
Time string The last update timestamp of a Cloud Function.
- Version
Id string The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
- Build
Id string The Cloud Build ID of the latest successful deployment of the function.
- Build
Name string The Cloud Build Name of the function deployment.
projects//locations//builds/
.- Id string
The provider-assigned unique ID for this managed resource.
- Status string
Status of the function deployment.
- Update
Time string The last update timestamp of a Cloud Function.
- Version
Id string The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
- build
Id String The Cloud Build ID of the latest successful deployment of the function.
- build
Name String The Cloud Build Name of the function deployment.
projects//locations//builds/
.- id String
The provider-assigned unique ID for this managed resource.
- status String
Status of the function deployment.
- update
Time String The last update timestamp of a Cloud Function.
- version
Id String The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
- build
Id string The Cloud Build ID of the latest successful deployment of the function.
- build
Name string The Cloud Build Name of the function deployment.
projects//locations//builds/
.- id string
The provider-assigned unique ID for this managed resource.
- status string
Status of the function deployment.
- update
Time string The last update timestamp of a Cloud Function.
- version
Id string The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
- 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/
.- id str
The provider-assigned unique ID for this managed resource.
- status str
Status of the function deployment.
- 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.
- build
Id String The Cloud Build ID of the latest successful deployment of the function.
- build
Name String The Cloud Build Name of the function deployment.
projects//locations//builds/
.- id String
The provider-assigned unique ID for this managed resource.
- status String
Status of the function deployment.
- update
Time String The last update timestamp of a Cloud Function.
- version
Id String The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
Supporting Types
EventTrigger
- Event
Type string The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.- 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.- Failure
Policy Pulumi.Google Native. Cloud Functions. V1. Inputs. Failure Policy Specifies policy for failed executions.
- 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 thegoogle.storage
namespace.
- Event
Type string The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.- 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.- Failure
Policy FailurePolicy Specifies policy for failed executions.
- 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 thegoogle.storage
namespace.
- event
Type String The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.- 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.- failure
Policy FailurePolicy Specifies policy for failed executions.
- 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 thegoogle.storage
namespace.
- event
Type string The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.- 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.- failure
Policy FailurePolicy Specifies policy for failed executions.
- 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 thegoogle.storage
namespace.
- event_
type str The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.- 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.- failure_
policy FailurePolicy Specifies policy for failed executions.
- 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 thegoogle.storage
namespace.
- event
Type String The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.- 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.- failure
Policy Property Map Specifies policy for failed executions.
- 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 thegoogle.storage
namespace.
EventTriggerResponse
- Event
Type string The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 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 Pulumi.Google Native. Cloud Functions. V1. Inputs. Failure Policy Response 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. 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 thegoogle.storage
namespace.
- Event
Type string The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 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 FailurePolicy Response 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. 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 thegoogle.storage
namespace.
- event
Type String The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 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 FailurePolicy Response 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. 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 thegoogle.storage
namespace.
- event
Type string The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 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 FailurePolicy Response 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. 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 thegoogle.storage
namespace.
- event_
type str The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 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 FailurePolicy Response 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. 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 thegoogle.storage
namespace.
- event
Type String The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.change
andproviders/cloud.pubsub/eventTypes/topic.publish
. Event types match patternproviders/*/eventTypes/*.*
. The pattern contains: 1. namespace: For example,cloud.storage
andgoogle.firebase.analytics
. 2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the typeobject
. 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 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 theCloudFunction
. 2. The resource type must match the pattern expected for anevent_type
. For example, anEventTrigger
that has anevent_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 anEventTrigger
. 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 thegoogle.storage
namespace.
FailurePolicy
- Retry
Pulumi.
Google Native. Cloud Functions. V1. Inputs. Retry 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.
FailurePolicyResponse
- Retry
Pulumi.
Google Native. Cloud Functions. V1. Inputs. Retry Response If specified, then the function will be retried in case of a failure.
- Retry
Retry
Response If specified, then the function will be retried in case of a failure.
- retry
Retry
Response If specified, then the function will be retried in case of a failure.
- retry
Retry
Response If specified, then the function will be retried in case of a failure.
- retry
Retry
Response 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.
FunctionDockerRegistry
- Docker
Registry Unspecified - DOCKER_REGISTRY_UNSPECIFIED
Unspecified.
- Container
Registry - CONTAINER_REGISTRY
Docker images will be stored in multi-regional Container Registry repositories named
gcf
. - Artifact
Registry - ARTIFACT_REGISTRY
Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named
gcf-artifacts
in every region in which a function is deployed. But the repository to use can also be specified by the user using thedocker_repository
field.
- Function
Docker Registry Docker Registry Unspecified - DOCKER_REGISTRY_UNSPECIFIED
Unspecified.
- Function
Docker Registry Container Registry - CONTAINER_REGISTRY
Docker images will be stored in multi-regional Container Registry repositories named
gcf
. - Function
Docker Registry Artifact Registry - ARTIFACT_REGISTRY
Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named
gcf-artifacts
in every region in which a function is deployed. But the repository to use can also be specified by the user using thedocker_repository
field.
- Docker
Registry Unspecified - DOCKER_REGISTRY_UNSPECIFIED
Unspecified.
- Container
Registry - CONTAINER_REGISTRY
Docker images will be stored in multi-regional Container Registry repositories named
gcf
. - Artifact
Registry - ARTIFACT_REGISTRY
Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named
gcf-artifacts
in every region in which a function is deployed. But the repository to use can also be specified by the user using thedocker_repository
field.
- Docker
Registry Unspecified - DOCKER_REGISTRY_UNSPECIFIED
Unspecified.
- Container
Registry - CONTAINER_REGISTRY
Docker images will be stored in multi-regional Container Registry repositories named
gcf
. - Artifact
Registry - ARTIFACT_REGISTRY
Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named
gcf-artifacts
in every region in which a function is deployed. But the repository to use can also be specified by the user using thedocker_repository
field.
- DOCKER_REGISTRY_UNSPECIFIED
- DOCKER_REGISTRY_UNSPECIFIED
Unspecified.
- CONTAINER_REGISTRY
- CONTAINER_REGISTRY
Docker images will be stored in multi-regional Container Registry repositories named
gcf
. - ARTIFACT_REGISTRY
- ARTIFACT_REGISTRY
Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named
gcf-artifacts
in every region in which a function is deployed. But the repository to use can also be specified by the user using thedocker_repository
field.
- "DOCKER_REGISTRY_UNSPECIFIED"
- DOCKER_REGISTRY_UNSPECIFIED
Unspecified.
- "CONTAINER_REGISTRY"
- CONTAINER_REGISTRY
Docker images will be stored in multi-regional Container Registry repositories named
gcf
. - "ARTIFACT_REGISTRY"
- ARTIFACT_REGISTRY
Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named
gcf-artifacts
in every region in which a function is deployed. But the repository to use can also be specified by the user using thedocker_repository
field.
FunctionIngressSettings
- Ingress
Settings Unspecified - INGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- Allow
All - ALLOW_ALL
Allow HTTP traffic from public and private sources.
- Allow
Internal Only - ALLOW_INTERNAL_ONLY
Allow HTTP traffic from only private VPC sources.
- Allow
Internal And Gclb - ALLOW_INTERNAL_AND_GCLB
Allow HTTP traffic from private VPC sources and through GCLB.
- Function
Ingress Settings Ingress Settings Unspecified - INGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- Function
Ingress Settings Allow All - ALLOW_ALL
Allow HTTP traffic from public and private sources.
- Function
Ingress Settings Allow Internal Only - ALLOW_INTERNAL_ONLY
Allow HTTP traffic from only private VPC sources.
- Function
Ingress Settings Allow Internal And Gclb - ALLOW_INTERNAL_AND_GCLB
Allow HTTP traffic from private VPC sources and through GCLB.
- Ingress
Settings Unspecified - INGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- Allow
All - ALLOW_ALL
Allow HTTP traffic from public and private sources.
- Allow
Internal Only - ALLOW_INTERNAL_ONLY
Allow HTTP traffic from only private VPC sources.
- Allow
Internal And Gclb - ALLOW_INTERNAL_AND_GCLB
Allow HTTP traffic from private VPC sources and through GCLB.
- Ingress
Settings Unspecified - INGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- Allow
All - ALLOW_ALL
Allow HTTP traffic from public and private sources.
- Allow
Internal Only - ALLOW_INTERNAL_ONLY
Allow HTTP traffic from only private VPC sources.
- Allow
Internal And Gclb - ALLOW_INTERNAL_AND_GCLB
Allow HTTP traffic from private VPC sources and through GCLB.
- INGRESS_SETTINGS_UNSPECIFIED
- INGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- ALLOW_ALL
- ALLOW_ALL
Allow HTTP traffic from public and private sources.
- ALLOW_INTERNAL_ONLY
- ALLOW_INTERNAL_ONLY
Allow HTTP traffic from only private VPC sources.
- ALLOW_INTERNAL_AND_GCLB
- ALLOW_INTERNAL_AND_GCLB
Allow HTTP traffic from private VPC sources and through GCLB.
- "INGRESS_SETTINGS_UNSPECIFIED"
- INGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- "ALLOW_ALL"
- ALLOW_ALL
Allow HTTP traffic from public and private sources.
- "ALLOW_INTERNAL_ONLY"
- ALLOW_INTERNAL_ONLY
Allow HTTP traffic from only private VPC sources.
- "ALLOW_INTERNAL_AND_GCLB"
- ALLOW_INTERNAL_AND_GCLB
Allow HTTP traffic from private VPC sources and through GCLB.
FunctionVpcConnectorEgressSettings
- Vpc
Connector Egress Settings Unspecified - VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- Private
Ranges Only - PRIVATE_RANGES_ONLY
Use the VPC Access Connector only for private IP space from RFC1918.
- All
Traffic - ALL_TRAFFIC
Force the use of VPC Access Connector for all egress traffic from the function.
- Function
Vpc Connector Egress Settings Vpc Connector Egress Settings Unspecified - VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- Function
Vpc Connector Egress Settings Private Ranges Only - PRIVATE_RANGES_ONLY
Use the VPC Access Connector only for private IP space from RFC1918.
- Function
Vpc Connector Egress Settings All Traffic - ALL_TRAFFIC
Force the use of VPC Access Connector for all egress traffic from the function.
- Vpc
Connector Egress Settings Unspecified - VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- Private
Ranges Only - PRIVATE_RANGES_ONLY
Use the VPC Access Connector only for private IP space from RFC1918.
- All
Traffic - ALL_TRAFFIC
Force the use of VPC Access Connector for all egress traffic from the function.
- Vpc
Connector Egress Settings Unspecified - VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- Private
Ranges Only - PRIVATE_RANGES_ONLY
Use the VPC Access Connector only for private IP space from RFC1918.
- All
Traffic - ALL_TRAFFIC
Force the use of VPC Access Connector for all egress traffic from the function.
- VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED
- VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- PRIVATE_RANGES_ONLY
- PRIVATE_RANGES_ONLY
Use the VPC Access Connector only for private IP space from RFC1918.
- ALL_TRAFFIC
- ALL_TRAFFIC
Force the use of VPC Access Connector for all egress traffic from the function.
- "VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED"
- VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED
Unspecified.
- "PRIVATE_RANGES_ONLY"
- PRIVATE_RANGES_ONLY
Use the VPC Access Connector only for private IP space from RFC1918.
- "ALL_TRAFFIC"
- ALL_TRAFFIC
Force the use of VPC Access Connector for all egress traffic from the function.
HttpsTrigger
- Security
Level Pulumi.Google Native. Cloud Functions. V1. Https Trigger Security Level The security level for the function.
- Security
Level HttpsTrigger Security Level The security level for the function.
- security
Level HttpsTrigger Security Level The security level for the function.
- security
Level HttpsTrigger Security Level The security level for the function.
- security_
level HttpsTrigger Security Level The security level for the function.
- security
Level "SECURITY_LEVEL_UNSPECIFIED" | "SECURE_ALWAYS" | "SECURE_OPTIONAL" The security level for the function.
HttpsTriggerResponse
- Security
Level string The security level for the function.
- Url string
The deployed url for the function.
- Security
Level string The security level for the function.
- Url string
The deployed url for the function.
- security
Level String The security level for the function.
- url String
The deployed url for the function.
- security
Level 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.
- security
Level String The security level for the function.
- url String
The deployed url for the function.
HttpsTriggerSecurityLevel
- Security
Level Unspecified - SECURITY_LEVEL_UNSPECIFIED
Unspecified.
- Secure
Always - SECURE_ALWAYS
Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.
- Secure
Optional - SECURE_OPTIONAL
Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.
- Https
Trigger Security Level Security Level Unspecified - SECURITY_LEVEL_UNSPECIFIED
Unspecified.
- Https
Trigger Security Level Secure Always - SECURE_ALWAYS
Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.
- Https
Trigger Security Level Secure Optional - SECURE_OPTIONAL
Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.
- Security
Level Unspecified - SECURITY_LEVEL_UNSPECIFIED
Unspecified.
- Secure
Always - SECURE_ALWAYS
Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.
- Secure
Optional - SECURE_OPTIONAL
Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.
- Security
Level Unspecified - SECURITY_LEVEL_UNSPECIFIED
Unspecified.
- Secure
Always - SECURE_ALWAYS
Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.
- Secure
Optional - SECURE_OPTIONAL
Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.
- SECURITY_LEVEL_UNSPECIFIED
- SECURITY_LEVEL_UNSPECIFIED
Unspecified.
- SECURE_ALWAYS
- SECURE_ALWAYS
Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.
- SECURE_OPTIONAL
- SECURE_OPTIONAL
Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.
- "SECURITY_LEVEL_UNSPECIFIED"
- SECURITY_LEVEL_UNSPECIFIED
Unspecified.
- "SECURE_ALWAYS"
- SECURE_ALWAYS
Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.
- "SECURE_OPTIONAL"
- SECURE_OPTIONAL
Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.
SecretEnvVar
- 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.
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.
SecretVersion
- 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.
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.
SecretVolume
- Mount
Path string The path within the container to mount the secret volume. For example, setting the mount_path as
/etc/secrets
would mount the secret value files under the/etc/secrets
directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount 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.
Google Native. Cloud Functions. V1. Inputs. Secret Version> 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 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
[]Secret
Version 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 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<Secret
Version> 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 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
Secret
Version[] 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[Secret
Version] 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 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.
SecretVolumeResponse
- Mount
Path string The path within the container to mount the secret volume. For example, setting the mount_path as
/etc/secrets
would mount the secret value files under the/etc/secrets
directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount 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.
Google Native. Cloud Functions. V1. Inputs. Secret Version Response> 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 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
[]Secret
Version Response 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 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<Secret
Version Response> 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 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
Secret
Version Response[] 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[Secret
Version Response] 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 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.
SourceRepository
- 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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- 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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- 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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- 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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- 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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- 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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
SourceRepositoryResponse
- Deployed
Url 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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- Deployed
Url 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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- deployed
Url 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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- deployed
Url 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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
- deployed
Url 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 usemaster
moveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*
You may omitpaths/*
if you want to use the main directory.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0