page:recipes:graphql api:nestjs:artifact storage
Host graphql api with NestJS: stored input and output artifacts
Summary
Deploy a graphql api built with NestJS on Ample using the generated downloads pattern. Compute runs the app in an isolated microVM behind a public HTTPS URL, a managed PostgreSQL 16 database is auto-provisioned and injected as DATABASE_URL, a private S3-compatible bucket holds objects with credentials delivered as encrypted environment variables. Verified on NestJS: an export query rendered to a CSV artifact stored with metadata in a private bucket and returned only to an authorized caller (401 without token, export=ok rows=3). Not separately tested: your export formats, retention policy and entitlement model; treat the graphql api-specific behavior as your application code.
Representative Queries
- Host graphql api with NestJS: stored input and output artifacts
- Where can I host GraphQL API built with NestJS?
- I need an input/output artifact contract, object metadata and access boundaries.
Resource Requirements
- primitive:compute
- primitive:postgres
- primitive:s3-compatible-object-storage
Infrastructure Requirements
- Compute
Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes. - Postgres
Managed PostgreSQL 16 runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied. - S3-compatible object storage
Buckets are S3-compatible with issued credentials; PutObject and GetObject are verified by canary. Other S3 operations are not verified.
Prerequisites
- A NestJS project that builds and starts with the documented commands (npm install, nest build (TypeScript) then node dist/main.js on the node-22 template)
- A PostgreSQL driver reading DATABASE_URL at runtime (auto-provisioned when omitted, or supplied with --env)
- A bucket from
ample bucket createwith its credentials passed as encrypted S3_* environment variables - An Ample account token with servers:write, databases:read, buckets:read
Workflow Steps
- Build and start
npm install, nest build (TypeScript) then node dist/main.js on the node-22 template. The server must bind 0.0.0.0 on PORT. - Implement the pattern on PostgreSQL
The fixture's module implements generated downloads: an export query rendered to a CSV artifact stored with metadata in a private bucket and returned only to an authorized caller (401 without token, export=ok rows=3). Copy the approach into your schema; keep migrations idempotent and run them with --release-command. - Wire object storage
Create the bucket(s), then pass endpoint, region, bucket and keys as --env values. Use path-style addressing. Keep private data in an unpublished bucket. - Deploy
Run the synchronous deploy once and read the result (exit 0 live, 1 failed, 2 blocked). Re-running with no change is a no-op.ample deploy . --name --public --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=... - Verify
Fetch the live URL and the pattern self-test route(s) (/p/generated-downloads) from the example; then run your own checks. On failure readample logs --kind buildthen--kind runtime.ample logs --kind build
Examples
- NestJS pattern fixture
Multi-pattern NestJS app whose generated downloads module was checked live; the module is under tests/deploy-canaries/_pattern-modules.
Success Checks
- App responds on its public URL
- Generated-downloads self-test:
export=ok rows=3 (with ?token=...; 401 without)
Limitations
- Verified on the node-22 template at s-1vcpu-1gb with the example fixture; other sizes, templates and NestJS major versions are not verified.
- The graphql api itself (your export formats, retention policy and entitlement model) is application code and was not separately tested; the pattern checks are what was verified.
Cost Estimate
- Currency: USD
- Monthly Amount: 10.0
- Components:
- App server: s-1vcpu-1gb, quantity: 1.0, amount: 5.0
- Managed PostgreSQL database: s-1vcpu-1gb, quantity: 1.0, amount: 5.0
Note: Always-on monthly price of the tested sizes; apps and databases auto-pause when idle. Buckets are allocation-priced per quota and not included.
Evidence Summary
- Canary Run: NestJS pattern fixture deployed on Ample (npm install, nest build (TypeScript) then node dist/main.js on the node-22 template); checks passed for generated-downloads and configuration-secrets.
- Kind: canary_run
- Summary: Pattern proof: an export query rendered to a CSV artifact stored with metadata in a private bucket and returned only to an authorized caller (401 without token, export=ok rows=3).
Last Verified
2026-09-21T02:34:39Z
Next Actions
- Browse the catalog index
- Method: GET
- Relative Path:
/v1/catalog
- Search published recipes
- Method: POST
- Relative Path:
/v1/catalog/search
- Prepare a side-effect-free deployment plan
- Method: POST
- Relative Path:
/v1/catalog/plan
- Read the existing agent authentication setup
- Method: GET
- Relative Path:
/mcp/setup
- Browse GraphQL API
- Method: GET
- Relative Path:
/v1/catalog/nodes/workload%3Agraphql-api
- Browse NestJS
- Method: GET
- Relative Path:
/v1/catalog/nodes/stack%3Aframework-nestjs
- Browse Generated downloads
- Method: GET
- Relative Path:
/v1/catalog/nodes/pattern%3Agenerated-downloads
- Browse Deploy API
- Method: GET
- Relative Path:
/v1/catalog/nodes/intent%3Adeploy-api