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) LoadEnvFromFile(path string) error
- func (p *Project) LoadFunction(name string) (*function.Function, error)
- func (p *Project) LoadFunctionByPath(name, path string) (*function.Function, error)
- func (p *Project) LoadFunctions(patterns ...string) error
- func (p *Project) Open() error
- func (p *Project) Rollback() error
- func (p *Project) RollbackVersion(version string) error
- func (p *Project) Setenv(name, value string)
Constants ¶
View Source
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 // DefaultRetainedVersions defines numbers of retained versions DefaultRetainedVersions = 10 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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"`
DefaultEnvironment string `json:"defaultEnvironment"`
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
Environment string
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) DeployAndClean ¶
DeployAndClean deploys functions and then cleans up their build artifacts.
func (*Project) FunctionDirNames ¶ added in v0.4.0
FunctionDirNames returns a list of function directory names.
func (*Project) LoadEnvFromFile ¶ added in v0.10.0
LoadEnvFromFile reads `path` JSON and applies it to the environment.
func (*Project) LoadFunction ¶ added in v0.7.0
LoadFunction returns the function in the ./functions/<name> directory.
func (*Project) LoadFunctionByPath ¶ added in v0.7.0
LoadFunctionByPath returns the function in the given directory.
func (*Project) LoadFunctions ¶ added in v0.6.0
LoadFunctions reads the ./functions directory, populating the Functions field. If no `patterns` are specified, all functions are loaded.
func (*Project) RollbackVersion ¶ added in v0.9.0
RollbackVersion project functions to the specified version.
Source Files
Click to show internal directories.
Click to hide internal directories.