Getting Started

plugins:
  - '@interlace/serverless-api-gateway-caching'

custom:
  interlaceCaching:
    enabled: true
    clusterSize: '0.5'
    ttlInSeconds: 300
    flushOnDeploy: true

functions:
  getUser:
    handler: src/handler.get
    events:
      - http:
          path: /users/{id}
          method: get
          caching:
            enabled: true
            cacheKeyParameters:
              - name: request.path.id

import { defineConfig, defineFunction } from '@interlace/serverless-devkit';

export default defineConfig({
  service: 'my-api',
  provider: {
    name: 'aws',
    runtime: 'nodejs20.x',
    region: 'us-east-1',
  },
  plugins: ['@interlace/serverless-api-gateway-caching'],
  custom: {
    interlaceCaching: {
      enabled: true,
      clusterSize: '0.5',
      ttlInSeconds: 300,
    },
  },
  functions: {
    getUser: defineFunction({
      handler: 'src/handler.get',
      events: [
        {
          http: {
            path: '/users/{id}',
            method: 'get',
            caching: {
              enabled: true,
              cacheKeyParameters: [{ name: 'request.path.id' }],
            },
          },
        },
      ],
    }),
  },
});

sls deploy --aws-profile interlace

sls caching status
# --- Cache Status ---
#   Enabled:  true
#   Size:     0.5 GB
#   Status:   AVAILABLE