/apex

Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
Raw Blame History
167 lines (105 sloc) 4.68 KB

A "project" is the largest unit of abstraction in Apex. A project consists of collection of AWS Lambda functions, and all apex(1) operations have access to these functions.

Configuration

Projects have a project.json file in the root directory. This file contains details about your project, as well as defaults for functions, if desired. Here's an example of a project.json file declaring a default AWS IAM "role" and "memory" for all functions.

{
  "name": "node",
  "description": "Node.js example project",
  "role": "arn:aws:iam::293503197324:role/lambda",
  "memory": 512
}

Multiple Environments

Multiple environments are supported with the --env flag. By default project.json and function.json are used, however when --env is specified project.ENV.json and function.ENV.json will be used, falling back on function.json for cases when staging and production config is the same. For example your directory structure may look something like the following:

project.stage.json
project.prod.json
functions
├── bar
│   ├── function.stage.json
│   ├── function.prod.json
│   └── index.js
└── foo
    ├── function.stage.json
    ├── function.prod.json
    └── index.js

If you prefer your "dev" or "staging" environment to be the implied default then leave the files as project.json and function.json:

project.json
project.prod.json
functions
├── bar
│   ├── function.json
│   ├── function.prod.json
│   └── index.js
└── foo
    ├── function.json
    ├── function.prod.json
    └── index.js

Symlinks

It's important to note that Apex supports symlinked files and directories. Apex will read the links and pull in these files, even if the links aren't to files within your function. This enables the use of npm link, shared configuration and so on.

Fields

name

Name of the project. This field is used in the default value for "nameTemplate" to prevent collisions between multiple projects.

  • type: string
  • required

description

Description of the project. This field is informational.

  • type: string

runtime

Default runtime of function(s) unless specified in their function.json configuration.

  • type: string

Runtimes supported:

  • java (Java 8)
  • python2.7 (Python 2.7)
  • python3.6 (Python 3.6)
  • ruby2.5 (Ruby 2.5)
  • nodejs4.3 (Node.js 4.3)
  • nodejs4.3-edge (Node.js 4.3 Edge)
  • nodejs6.10 (Node.js 6.10)
  • golang (any version)
  • clojure (any version)
  • rust-musl[^rust-runtime][^rust-linux-only] (any version)
  • rust-gnu[^rust-runtime][^rust-linux-only] (any version)

[^rust-runtime]: Rust has two types of libc dependencies and the rust-musl is recommended. Your rust lambda function may refuse to run because of glibc version mismatch between lambda server and your pc when rust-gnu runtime is used.

[^rust-linux-only]: Rust version of lambda currently can only be built on linux machine. If you try to build on MacOS, you will encounter the linker error. One solution is using apex inside a linux docker container on MacOS.

memory

Default memory allocation of function(s) unless specified in their function.json configuration.

  • type: int

timeout

Default timeout of function(s) unless specified in their function.json configuration.

  • type: int

role

Default role of function(s) unless specified in their function.json configuration.

  • type: string

profile

Name of the AWS profile to use, this is the name used to locate AWS credentials in ~/.aws/credentials. Use this if you'd prefer not to specify AWS_PROFILE or --profile.

  • type: string

region

Name of the AWS region to use. Use this if you'd prefer not to specify AWS_REGION or --region.

  • type: string

defaultEnvironment

Default infrastructure environment.

  • type: string

environment

Default environment variables of function(s) unless specified in their function.json configuration.

  • type: object

nameTemplate

Template used to compute the function names. By default the template {{.Project.Name}}_{{.Function.Name}} is used, for example project "api" and ./functions/users becomes "api_users". To disable prefixing, use {{.Function.Name}}, which would result in "users".

  • type: string

retainedVersions

Default number of retained function's versions on AWS Lambda unless specified in their function.json configuration.

  • type: int

vpc

Default VPC configuration of function(s) unless specified in their function.json configuration.

  • type: object

vpc.securityGroups

List of security groups IDs

  • type: array

vpc.subnets

List of subnets IDs

  • type: array