This submodule configures a function sourced from a Cloud Source Repositories repository to respond to a given event trigger.
Alternatively, the root module configures a function sourced from a directory on localhost.
The automatic-labelling-from-repository example is a tested reference of how to use this submodule with the event-project-log-entry submodule.
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| available_memory_mb | The amount of memory in megabytes allotted for the function to use. | number |
256 |
no |
| description | The description of the function. | string |
"Processes events." |
no |
| entry_point | The name of a method in the function source which will be invoked when the function is executed. | string |
n/a | yes |
| environment_variables | A set of key/value environment variable pairs to assign to the function. | map(string) |
{} |
no |
| event_trigger | A source that fires events in response to a condition in another service. | map(string) |
{} |
no |
| event_trigger_failure_policy_retry | A toggle to determine if the function should be retried on failure. | bool |
false |
no |
| ingress_settings | The ingress settings for the function. Allowed values are ALLOW_ALL, ALLOW_INTERNAL_AND_GCLB and ALLOW_INTERNAL_ONLY. Changes to this field will recreate the cloud function. | string |
"ALLOW_ALL" |
no |
| labels | A set of key/value label pairs to assign to any lableable resources. | map(string) |
{} |
no |
| max_instances | The maximum number of parallel executions of the function. | number |
null |
no |
| name | The name to apply to any nameable resources. | string |
n/a | yes |
| project_id | The ID of the project to which resources will be applied. | string |
n/a | yes |
| region | The region in which resources will be applied. | string |
n/a | yes |
| runtime | The runtime in which the function will be executed. | string |
"nodejs6" |
no |
| service_account_email | The service account to run the function as. | string |
"" |
no |
| source_repository_url | The URL of the repository which contains the function source code. | string |
n/a | yes |
| timeout_s | The amount of time in seconds allotted for the execution of the function. | number |
60 |
no |
| timeouts | Timeout setting to customize how long certain operations(create, update, delete) are allowed to take before being considered to have failed. | map(string) |
{} |
no |
| trigger_http | Wheter to use HTTP trigger instead of the event trigger. | bool |
null |
no |
| vpc_connector | The VPC Network Connector that this cloud function can connect to. It should be set up as fully-qualified URI. The format of this field is projects//locations//connectors/*. | string |
null |
no |
| vpc_connector_egress_settings | The egress settings for the connector, controlling what traffic is diverted through it. Allowed values are ALL_TRAFFIC and PRIVATE_RANGES_ONLY. If unset, this field preserves the previously set value. | string |
null |
no |
| Name | Description |
|---|---|
| https_trigger_url | URL which triggers function execution. |
| name | The name of the function. |
The following sections describe the requirements which must be met in order to invoke this module.
The following software dependencies must be installed on the system from which this module will be invoked:
The Service Account which will be used to invoke this module must have the following IAM roles:
- Cloud Functions Developer:
roles/cloudfunctions.developer
The project against which this module will be invoked must have the following APIs enabled:
- Cloud Functions API:
cloudfunctions.googleapis.com