project

Documentation

Overview

Package project implements multi-function operations.

Index

• Constants
• type Config
• type Project
  • func (p *Project) Clean() error
  • func (p *Project) Delete() error
  • func (p *Project) Deploy() error
  • func (p *Project) DeployAndClean() error
  • func (p *Project) FunctionDirNames() (list []string, err error)
  • func (p *Project) LoadFunction(name string) (*function.Function, error)
  • func (p *Project) LoadFunctionByPath(name, path string) (*function.Function, error)
  • func (p *Project) LoadFunctions(names ...string) error
  • func (p *Project) Open() error
  • func (p *Project) Setenv(name, value string)

Constants

const (
	// DefaultMemory defines default memory value (MB) for every function in a project
	DefaultMemory = 128

	// DefaultTimeout defines default timeout value (s) for every function in a project
	DefaultTimeout = 3
)

Types

type Config

type Config struct {
	Name             string            `json:"name" validate:"nonzero"`
	Description      string            `json:"description"`
	Runtime          string            `json:"runtime"`
	Memory           int64             `json:"memory"`
	Timeout          int64             `json:"timeout"`
	Role             string            `json:"role"`
	Handler          string            `json:"handler"`
	Shim             bool              `json:"shim"`
	NameTemplate     string            `json:"nameTemplate"`
	RetainedVersions int               `json:"retainedVersions"`
	Environment      map[string]string `json:"environment"`
	Hooks            hooks.Hooks       `json:"hooks"`
	VPC              vpc.VPC           `json:"vpc"`
}

Config for project.

type Project

type Project struct {
	Config
	Path        string
	Alias       string
	Concurrency int
	Log         log.Interface
	Service     lambdaiface.LambdaAPI
	Functions   []*function.Function
	IgnoreFile  []byte
	// contains filtered or unexported fields
}

Project represents zero or more Lambda functions.

func (*Project) Clean

func (p *Project) Clean() error

Clean up function build artifacts.

func (*Project) Delete

func (p *Project) Delete() error

Delete functions.

func (*Project) Deploy

func (p *Project) Deploy() error

Deploy functions and their configurations.

func (*Project) DeployAndClean

func (p *Project) DeployAndClean() error

DeployAndClean deploys functions and then cleans up their build artifacts.

func (*Project) FunctionDirNames

func (p *Project) FunctionDirNames() (list []string, err error)

FunctionDirNames returns a list of function directory names.

func (*Project) LoadFunction

func (p *Project) LoadFunction(name string) (*function.Function, error)

LoadFunction returns the function in the ./functions/<name> directory.

func (*Project) LoadFunctionByPath

func (p *Project) LoadFunctionByPath(name, path string) (*function.Function, error)

LoadFunctionByPath returns the function in the given directory.

func (*Project) LoadFunctions

func (p *Project) LoadFunctions(names ...string) error

LoadFunctions reads the ./functions directory, populating the Functions field. If no `names` are specified, all functions are loaded.

func (*Project) Open

func (p *Project) Open() error

Open the project.json file and prime the config.

func (*Project) Setenv

func (p *Project) Setenv(name, value string)

Setenv sets environment variable `name` to `value` on every function in project.