up.json

Up configuration file

Type object
File match up.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/up-json/latest.json
Source https://www.schemastore.org/up.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

name string required

A machine-friendly project name.

Examples: "apex-site", "apex-api", "ping-app"
description string

An optional project description.

Examples: "Marketing site", "Public API"
type string

The type of project.

Default: "server"
Values: "static" "server"
Examples: "static"
profile string

AWS credentials profile name, these are stored in ~/.aws/credentials.

Examples: "apex-prod", "apex-dev", "personal"
regions string[]

List of target AWS regions for deployment.

minItems=1
lambda object
5 nested properties
accelerate boolean

Enable S3 acceleration for faster uploads via the CloudFront CDN.

Default: false
warm boolean

Active warming mitigates cold starts when enabled.

Default: false
warm_rate string

Active warming sends requests to your application at this interval.

Default: "15m"
Examples: "5m", "30m"
warm_count integer

Number of concurrent containers to warm.

Default: "15"
memory integer

Lambda memory size.

Default: 512
Values: 128 192 256 320 384 448 512 576 640 704 768 832 896 960 1024 1088 1152 1216 1280 1344 1408 1472 1536 1600 1664 1728 1792 1856 1920 1984 2048 2112 2176 2240 2304 2368 2432 2496 2560 2624 2688 2752 2816 2880 2944 3008
stages object
3 nested properties
production object
1 nested properties
domain string

Domain hostname for the stage.

Default: ""
Examples: "gh-polls.com", "api.gh-polls.com"
staging object
1 nested properties
domain string

Domain hostname for the stage.

Default: ""
Examples: "stage.gh-polls.com", "gh-polls-staging.com"
development object
1 nested properties
domain string

Domain hostname for the stage.

Default: ""
Examples: "dev.gh-polls.com"
hooks object
6 nested properties
build string

Hook command(s) to run.

clean string

Hook command(s) to run.

prebuild string

Hook command(s) to run.

postbuild string

Hook command(s) to run.

predeploy string

Hook command(s) to run.

postdeploy string

Hook command(s) to run.

static object
2 nested properties
dir string

Path to directory from which assets are served.

Default: "."
Examples: "public", "./dist"
prefix string

Optional URL path prefix.

Examples: "/public/", "/static/"
proxy object
5 nested properties
command string

Command run to start your application.

Default: "./server"
Examples: "node app.js"
timeout integer

Timeout in seconds per request.

Default: 15
listen_timeout integer

Timeout in seconds Up will wait for your app to boot and listen on PORT.

Default: 15
shutdown_timeout integer

Timeout in seconds Up will wait after sending a SIGINT to your server, before sending a SIGKILL.

Default: 15
backoff object
5 nested properties
min integer

Minimum time in milliseconds before retrying.

Default: 500
max integer

Maximum time in milliseconds before retrying.

Default: 1500
factor number

Factor applied to each attempt.

Default: 1.5
attempts integer

Attempts made before failing.

Default: 5
jitter boolean

Apply jitter.

Default: false
dns object
environment object
headers object
error_pages object
3 nested properties
disable boolean

Disable default error pages.

Default: false
dir string

Path to directory from which error pages are served.

Default: "."
Examples: "public", "./dist"
variables object
2 nested properties
support_email string

Support email for contact link.

Examples: "[email protected]"
color string

Theme color.

Examples: "#228ae6"
cors object
7 nested properties
enable boolean

Enable Cross-Origin Resource Sharing.

Default: false
allowed_origins string[]
allowed_methods string[]
allowed_headers string[]
exposed_headers string[]
max_age integer

A number indicating how long (in seconds) the results of a preflight request can be cached.

Default: 0
allowed_credentials boolean

A boolean indicating whether the request can include user credentials such as cookies, HTTP authentication or client side SSL certificates. Defaults to true.

Default: true
inject object
redirects object
actions object[]
alerts object[]