Class FunctionArgs

Inheritance

System.Object

InputArgs

ResourceArgs

FunctionArgs

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.CloudFunctions

Assembly: Pulumi.Gcp.dll

Syntax

public sealed class FunctionArgs : ResourceArgs

Constructors

FunctionArgs()

Declaration

public FunctionArgs()

Properties

AvailableMemoryMb

Memory (in MB), available to the function. Default value is 256MB. Allowed values are: 128MB, 256MB, 512MB, 1024MB, and 2048MB.

Declaration

public Input<int> AvailableMemoryMb { get; set; }

Property Value

Type	Description
Input<System.Int32>

Description

Description of the function.

Declaration

public Input<string> Description { get; set; }

Property Value

Type	Description
Input<System.String>

EntryPoint

Name of the function that will be executed when the Google Cloud Function is triggered.

Declaration

public Input<string> EntryPoint { get; set; }

Property Value

Type	Description
Input<System.String>

EnvironmentVariables

A set of key/value environment variable pairs to assign to the function.

Declaration

public InputMap<object> EnvironmentVariables { get; set; }

Property Value

Type	Description
InputMap<System.Object>

EventTrigger

A source that fires events in response to a condition in another service. Structure is documented below. Cannot be used with trigger_http.

Declaration

public Input<FunctionEventTriggerArgs> EventTrigger { get; set; }

Property Value

Type	Description
Input<FunctionEventTriggerArgs>

HttpsTriggerUrl

URL which triggers function execution. Returned only if trigger_http is used.

Declaration

public Input<string> HttpsTriggerUrl { get; set; }

Property Value

Type	Description
Input<System.String>

IngressSettings

String value that controls what traffic can reach the function. Allowed values are ALLOW_ALL and ALLOW_INTERNAL_ONLY. Changes to this field will recreate the cloud function.

Declaration

public Input<string> IngressSettings { get; set; }

Property Value

Type	Description
Input<System.String>

Labels

A set of key/value label pairs to assign to the function. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

Declaration

public InputMap<object> Labels { get; set; }

Property Value

Type	Description
InputMap<System.Object>

MaxInstances

The limit on the maximum number of function instances that may coexist at a given time.

Declaration

public Input<int> MaxInstances { get; set; }

Property Value

Type	Description
Input<System.Int32>

Name

A user-defined name of the function. Function names must be unique globally.

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

Project

Project of the function. If it is not provided, the provider project is used.

Declaration

public Input<string> Project { get; set; }

Property Value

Type	Description
Input<System.String>

Region

Region of function. Currently can be only "us-central1". If it is not provided, the provider region is used.

Declaration

public Input<string> Region { get; set; }

Property Value

Type	Description
Input<System.String>

Runtime

The runtime in which the function is going to run. Eg. "nodejs8", "nodejs10", "python37", "go111".

Declaration

public Input<string> Runtime { get; set; }

Property Value

Type	Description
Input<System.String>

ServiceAccountEmail

If provided, the self-provided service account to run the function with.

Declaration

public Input<string> ServiceAccountEmail { get; set; }

Property Value

Type	Description
Input<System.String>

SourceArchiveBucket

The GCS bucket containing the zip archive which contains the function.

Declaration

public Input<string> SourceArchiveBucket { get; set; }

Property Value

Type	Description
Input<System.String>

SourceArchiveObject

The source archive object (file) in archive bucket.

Declaration

public Input<string> SourceArchiveObject { get; set; }

Property Value

Type	Description
Input<System.String>

SourceRepository

Represents parameters related to source repository where a function is hosted. Cannot be set alongside source_archive_bucket or source_archive_object. Structure is documented below.

Declaration

public Input<FunctionSourceRepositoryArgs> SourceRepository { get; set; }

Property Value

Type	Description
Input<FunctionSourceRepositoryArgs>

Timeout

Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.

Declaration

public Input<int> Timeout { get; set; }

Property Value

Type	Description
Input<System.Int32>

TriggerHttp

Boolean variable. Any HTTP request (of a supported type) to the endpoint will trigger function execution. Supported HTTP request types are: POST, PUT, GET, DELETE, and OPTIONS. Endpoint is returned as https_trigger_url. Cannot be used with trigger_bucket and trigger_topic.

Declaration

public Input<bool> TriggerHttp { get; set; }

Property Value

Type	Description
Input<System.Boolean>

VpcConnector

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/*.

Declaration

public Input<string> VpcConnector { get; set; }

Property Value

Type	Description
Input<System.String>

VpcConnectorEgressSettings

The egress settings for the connector, controlling what traffic is diverted through it. Allowed values are ALL_TRAFFIC and PRIVATE_RANGES_ONLY. Defaults to PRIVATE_RANGES_ONLY. If unset, this field preserves the previously set value.

Declaration

public Input<string> VpcConnectorEgressSettings { get; set; }

Property Value

Type	Description
Input<System.String>