cloudfunctions

package
v1.0.0-beta.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 14, 2019 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

nolint: lll Package cloudfunctions exports types, functions, subpackages for provisioning cloudfunctions resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-google) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-gcp` repo](https://github.com/pulumi/pulumi-gcp/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-google` repo](https://github.com/terraform-providers/terraform-provider-google/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Function 

type Function struct {
	// contains filtered or unexported fields
}

Creates a new Cloud Function. For more information see [the official documentation](https://cloud.google.com/functions/docs/) and [API](https://cloud.google.com/functions/docs/apis).

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/cloudfunctions_function.html.markdown.

func GetFunction 

func GetFunction(ctx *pulumi.Context,
	name string, id pulumi.ID, state *FunctionState, opts ...pulumi.ResourceOpt) (*Function, error)

GetFunction gets an existing Function resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewFunction 

func NewFunction(ctx *pulumi.Context,
	name string, args *FunctionArgs, opts ...pulumi.ResourceOpt) (*Function, error)

NewFunction registers a new resource with the given unique name, arguments, and options.

func (*Function) AvailableMemoryMb 

func (r *Function) AvailableMemoryMb() *pulumi.IntOutput

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

func (*Function) Description 

func (r *Function) Description() *pulumi.StringOutput

Description of the function.

func (*Function) EntryPoint 

func (r *Function) EntryPoint() *pulumi.StringOutput

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

func (*Function) EnvironmentVariables added in v0.16.0 

func (r *Function) EnvironmentVariables() *pulumi.MapOutput

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

func (*Function) EventTrigger added in v0.16.1 

func (r *Function) EventTrigger() *pulumi.Output

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

func (*Function) HttpsTriggerUrl 

func (r *Function) HttpsTriggerUrl() *pulumi.StringOutput

URL which triggers function execution. Returned only if `triggerHttp` is used.

func (*Function) ID 

func (r *Function) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Function) Labels 

func (r *Function) Labels() *pulumi.MapOutput

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

func (*Function) MaxInstances added in v0.18.6 

func (r *Function) MaxInstances() *pulumi.IntOutput

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

func (*Function) Name 

func (r *Function) Name() *pulumi.StringOutput

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

func (*Function) Project 

func (r *Function) Project() *pulumi.StringOutput

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

func (*Function) Region 

func (r *Function) Region() *pulumi.StringOutput

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

func (*Function) Runtime added in v0.16.4 

func (r *Function) Runtime() *pulumi.StringOutput

The runtime in which the function is going to run. One of `"nodejs6"`, `"nodejs8"`, `"nodejs10"`, `"python37"`, `"go111"`. If empty, defaults to `"nodejs6"`. It's recommended that you override the default, as `"nodejs6"` is deprecated.

func (*Function) ServiceAccountEmail added in v0.18.0 

func (r *Function) ServiceAccountEmail() *pulumi.StringOutput

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

func (*Function) SourceArchiveBucket 

func (r *Function) SourceArchiveBucket() *pulumi.StringOutput

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

func (*Function) SourceArchiveObject 

func (r *Function) SourceArchiveObject() *pulumi.StringOutput

The source archive object (file) in archive bucket.

func (*Function) SourceRepository added in v0.18.0 

func (r *Function) SourceRepository() *pulumi.Output

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

func (*Function) Timeout 

func (r *Function) Timeout() *pulumi.IntOutput

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

func (*Function) TriggerHttp 

func (r *Function) TriggerHttp() *pulumi.BoolOutput

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 `httpsTriggerUrl`. Cannot be used with `triggerBucket` and `triggerTopic`.

func (*Function) URN 

func (r *Function) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type FunctionArgs 

type FunctionArgs struct {
	// Memory (in MB), available to the function. Default value is 256MB. Allowed values are: 128MB, 256MB, 512MB, 1024MB, and 2048MB.
	AvailableMemoryMb interface{}
	// Description of the function.
	Description interface{}
	// Name of the function that will be executed when the Google Cloud Function is triggered.
	EntryPoint interface{}
	// A set of key/value environment variable pairs to assign to the function.
	EnvironmentVariables interface{}
	// A source that fires events in response to a condition in another service. Structure is documented below. Cannot be used with `triggerHttp`.
	EventTrigger interface{}
	// URL which triggers function execution. Returned only if `triggerHttp` is used.
	HttpsTriggerUrl interface{}
	// A set of key/value label pairs to assign to the function.
	Labels interface{}
	// The limit on the maximum number of function instances that may coexist at a given time.
	MaxInstances interface{}
	// A user-defined name of the function. Function names must be unique globally.
	Name interface{}
	// Project of the function. If it is not provided, the provider project is used.
	Project interface{}
	// Region of function. Currently can be only "us-central1". If it is not provided, the provider region is used.
	Region interface{}
	// The runtime in which the function is going to run. One
	// of `"nodejs6"`, `"nodejs8"`, `"nodejs10"`, `"python37"`, `"go111"`. If empty,
	// defaults to `"nodejs6"`. It's recommended that you override the default, as
	// `"nodejs6"` is deprecated.
	Runtime interface{}
	// If provided, the self-provided service account to run the function with.
	ServiceAccountEmail interface{}
	// The GCS bucket containing the zip archive which contains the function.
	SourceArchiveBucket interface{}
	// The source archive object (file) in archive bucket.
	SourceArchiveObject interface{}
	// Represents parameters related to source repository where a function is hosted.
	// Cannot be set alongside `sourceArchiveBucket` or `sourceArchiveObject`. Structure is documented below.
	SourceRepository interface{}
	// Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.
	Timeout interface{}
	// 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 `httpsTriggerUrl`. Cannot be used with `triggerBucket` and `triggerTopic`.
	TriggerHttp interface{}
}

The set of arguments for constructing a Function resource.

type FunctionState 

type FunctionState struct {
	// Memory (in MB), available to the function. Default value is 256MB. Allowed values are: 128MB, 256MB, 512MB, 1024MB, and 2048MB.
	AvailableMemoryMb interface{}
	// Description of the function.
	Description interface{}
	// Name of the function that will be executed when the Google Cloud Function is triggered.
	EntryPoint interface{}
	// A set of key/value environment variable pairs to assign to the function.
	EnvironmentVariables interface{}
	// A source that fires events in response to a condition in another service. Structure is documented below. Cannot be used with `triggerHttp`.
	EventTrigger interface{}
	// URL which triggers function execution. Returned only if `triggerHttp` is used.
	HttpsTriggerUrl interface{}
	// A set of key/value label pairs to assign to the function.
	Labels interface{}
	// The limit on the maximum number of function instances that may coexist at a given time.
	MaxInstances interface{}
	// A user-defined name of the function. Function names must be unique globally.
	Name interface{}
	// Project of the function. If it is not provided, the provider project is used.
	Project interface{}
	// Region of function. Currently can be only "us-central1". If it is not provided, the provider region is used.
	Region interface{}
	// The runtime in which the function is going to run. One
	// of `"nodejs6"`, `"nodejs8"`, `"nodejs10"`, `"python37"`, `"go111"`. If empty,
	// defaults to `"nodejs6"`. It's recommended that you override the default, as
	// `"nodejs6"` is deprecated.
	Runtime interface{}
	// If provided, the self-provided service account to run the function with.
	ServiceAccountEmail interface{}
	// The GCS bucket containing the zip archive which contains the function.
	SourceArchiveBucket interface{}
	// The source archive object (file) in archive bucket.
	SourceArchiveObject interface{}
	// Represents parameters related to source repository where a function is hosted.
	// Cannot be set alongside `sourceArchiveBucket` or `sourceArchiveObject`. Structure is documented below.
	SourceRepository interface{}
	// Timeout (in seconds) for the function. Default value is 60 seconds. Cannot be more than 540 seconds.
	Timeout interface{}
	// 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 `httpsTriggerUrl`. Cannot be used with `triggerBucket` and `triggerTopic`.
	TriggerHttp interface{}
}

Input properties used for looking up and filtering Function resources.

type GetFunctionArgs 

type GetFunctionArgs struct {
	// The name of a Cloud Function.
	Name interface{}
	// The project in which the resource belongs. If it
	// is not provided, the provider project is used.
	Project interface{}
	// The region in which the resource belongs. If it
	// is not provided, the provider region is used.
	Region interface{}
}

A collection of arguments for invoking getFunction.

type GetFunctionResult 

type GetFunctionResult struct {
	// Available memory (in MB) to the function.
	AvailableMemoryMb interface{}
	// Description of the function.
	Description interface{}
	// Name of a JavaScript function that will be executed when the Google Cloud Function is triggered.
	EntryPoint           interface{}
	EnvironmentVariables interface{}
	// A source that fires events in response to a condition in another service. Structure is documented below.
	EventTriggers interface{}
	// If function is triggered by HTTP, trigger URL is set here.
	HttpsTriggerUrl interface{}
	// A map of labels applied to this function.
	Labels       interface{}
	MaxInstances interface{}
	// The name of the Cloud Function.
	Name    interface{}
	Project interface{}
	Region  interface{}
	// The runtime in which the function is running.
	Runtime             interface{}
	ServiceAccountEmail interface{}
	// The GCS bucket containing the zip archive which contains the function.
	SourceArchiveBucket interface{}
	// The source archive object (file) in archive bucket.
	SourceArchiveObject interface{}
	SourceRepositories  interface{}
	// Function execution timeout (in seconds).
	Timeout       interface{}
	TriggerBucket interface{}
	// If function is triggered by HTTP, this boolean is set.
	TriggerHttp  interface{}
	TriggerTopic interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getFunction.

func LookupFunction 

func LookupFunction(ctx *pulumi.Context, args *GetFunctionArgs) (*GetFunctionResult, error)

Get information about a Google Cloud Function. For more information see the [official documentation](https://cloud.google.com/functions/docs/) and [API](https://cloud.google.com/functions/docs/apis).

> This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/d/cloudfunctions_function.html.markdown.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.