SST

https://sst.dev/docs
Admin
SST is a framework for building modern full-stack applications. It allows defining your entire app...
Tokens:613,514
Snippets:6,334
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install and run SST dev

Source: https://sst.dev/docs/examples/aws-t3

Install dependencies and start the SST dev environment. This will deploy the database and VPC, which may take a few minutes, and starts a tunnel to connect your local machine to the RDS Postgres database.

```bash
npm install
npx sst dev
```

--------------------------------

### Install dependencies and start dev environment

Source: https://sst.dev/docs/examples/aws-jsx-email

Installs dependencies and starts the SST development environment. After running, you will receive a verification email from AWS.

```bash
npm install
npx sst dev

```

--------------------------------

### Start a task and get task ARN

Source: https://sst.dev/docs/component/aws/task

Example of starting a task and retrieving its ARN. This is a prerequisite for stopping a task.

```js
const runRet = await task.run(Resource.MyTask);
const taskArn = runRet.tasks[0].taskArn;
```

--------------------------------

### Create a TanStack Start project

Source: https://sst.dev/docs/start/aws/tanstack

Creates a new TanStack Start project. The init wizard prompts for project name, Tailwind, toolchain, deployment adapter, add-ons, and examples. Choose 'Nitro (agnostic)' as the deployment adapter to prepare for AWS deployment.

```bash
npm create @tanstack/start@latest

```

--------------------------------

### Deploy a TanStack Start app (minimal example)

Source: https://sst.dev/docs/component/aws/tan-stack-start

Deploys a TanStack Start app located in the project root. Requires the aws-lambda nitro preset in vite.config.ts.

```js
new sst.aws.TanStackStart("MyWeb");

```

--------------------------------

### Build output example

Source: https://sst.dev/docs/component/cloudflare/static-site

Example of setting the build output directory to 'build'.

```js
{
  build: {
    output: "build"
  }
}
```

--------------------------------

### Python uv sync command

Source: https://sst.dev/docs/component/aws/function

Install your packages before starting sst dev.

```bash
uv sync --all-packages
```

--------------------------------

### Build command example

Source: https://sst.dev/docs/component/cloudflare/static-site

Example of setting the build command to 'yarn build'.

```js
{
  build: {
    command: "yarn build"
  }
}
```

--------------------------------

### Install npm Packages

Source: https://sst.dev/docs/start/aws/deno

Installs the required npm packages for SST and AWS SDK using Deno's install command.

```bash
deno install npm:sst npm:@aws-sdk/client-s3 npm:@aws-sdk/lib-storage npm:@aws-sdk/s3-request-presigner

```

--------------------------------

### server argument example

Source: https://sst.dev/docs/component/aws/opencontrol

Example of the 'server' argument as a string.

```js
{
  server: "src/server.handler"
}

```

--------------------------------

### Install dependencies

Source: https://sst.dev/docs/set-up-a-monorepo

Run this command to install all dependencies for the monorepo.

```bash
npm install
```

--------------------------------

### Listeners configuration example

Source: https://sst.dev/docs/component/aws/alb

Example of configuring listeners for the load balancer.

```js
{
  listeners: [
    { port: 80, protocol: "http" },
    { port: 443, protocol: "https" }
  ]
}
```

--------------------------------

### Install dependencies

Source: https://sst.dev/docs/start/aws/auth

Installs the required npm packages for OpenAuth, valibot, and Hono.

```bash
npm install @openauthjs/openauth valibot hono

```

--------------------------------

### Delay configuration example

Source: https://sst.dev/docs/component/aws/queue

Example of setting the delay property for a queue.

```js
{
  delay: "10 seconds"
}
```

--------------------------------

### Install ioredis and router

Source: https://sst.dev/docs/start/aws/solid

Installs the ioredis and @solidjs/router packages for connecting to Redis and routing.

```bash
npm install ioredis @solidjs/router

```

--------------------------------

### Deploy a React app (minimal example)

Source: https://sst.dev/docs/component/aws/react

Deploys a React app located in the project root.

```js
new sst.aws.React("MyWeb");
```

--------------------------------

### Initialize Deno project

Source: https://sst.dev/docs/start/aws/deno

Initializes a new Deno project named aws-deno.

```bash
deno init aws-deno

```

--------------------------------

### Install puppeteer-core and @sparticuz/chromium

Source: https://sst.dev/docs/examples/aws-puppeteer

Install the specific versions of puppeteer-core and @sparticuz/chromium that are compatible with each other. The example uses Puppeteer v23.1.1 and Chromium v127.

```bash
npm install puppeteer-core@23.1.1 @sparticuz/chromium@127.0.0

```

--------------------------------

### Multi-region cluster with static get

Source: https://sst.dev/docs/component/aws/dsql

Example of using the static get method to reference a multi-region cluster, specifying the peer cluster ID and region.

```ts
const cluster = sst.aws.Dsql.get("MyCluster", {
  id: "app-dev-mycluster",
  peer: {
    id: "kzttrvbdg4k2o5ze2m2rrwdj7u",
    region: "us-east-2",
  }
});
```

--------------------------------

### Create and initialize the Express project

Source: https://sst.dev/docs/start/aws/express

Creates a new project directory, initializes a Node.js project, and installs Express.

```bash
mkdir aws-express && cd aws-express
npm init -y
npm install express

```

--------------------------------

### Import Example module

Source: https://sst.dev/docs/set-up-a-monorepo

Shows how to import and use the Example module from the core package.

```ts
import { Example } from "@monorepo-template/core/example";

Example.hello();
```

--------------------------------

### Initialize v3 app

Source: https://sst.dev/docs/migrate-from-v2

Initializes a new v3 app. Make sure to use the same app name as the v2 app.

```bash
npx sst init
```

--------------------------------

### Link resources to TanStack Start app

Source: https://sst.dev/docs/component/aws/tan-stack-start

Links resources to the TanStack Start app, granting permissions and allowing access via the SDK. The example links a bucket.

```ts
const bucket = new sst.aws.Bucket("MyBucket");

new sst.aws.TanStackStart("MyWeb", {
  link: [bucket]
});

```

--------------------------------

### Start tunnel for a specific stage

Source: https://sst.dev/docs/reference/cli

Starts a tunnel for a specific stage, useful when connecting to a different stage manually. Requires a network interface created with sst tunnel install.

```bash
sst tunnel --stage production
```

--------------------------------

### Start Dev Server - Command

Source: https://sst.dev/docs/examples/aws-deno-redis

Starts the app locally. After running, visit http://localhost:8000 to see the counter update on refresh.

```bash
sst dev
```

--------------------------------

### Create a SolidStart project

Source: https://sst.dev/docs/start/aws/solid

Creates a new SolidStart project named aws-solid-start and navigates into its directory. Select the SolidStart, basic, and TypeScript options when prompted.

```bash
npm init solid@latest aws-solid-start
cd aws-solid-start

```

--------------------------------

### Share bucket across stages

Source: https://sst.dev/docs/component/aws/bucket

Example of using static get to share a bucket from the dev stage in a personal stage. It conditionally gets or creates the bucket based on the stage.

```ts
const bucket = $app.stage === "frank"
  ? sst.aws.Bucket.get("MyBucket", "app-dev-mybucket-12345678")
  : new sst.aws.Bucket("MyBucket");

```

--------------------------------

### Resource ARN for CodeBuild startBuild

Source: https://sst.dev/docs/component/aws/step-functions/task

Example of a resource ARN to start an AWS CodeBuild build.

```ts
{
  resource: "arn:aws:states:::codebuild:startBuild"
}
```

--------------------------------

### Full shared ALB example with VPC, cluster, and services

Source: https://sst.dev/docs/examples/aws-shared-alb

Complete example creating a VPC, cluster, shared ALB, and two services (Api and Web) that share the same ALB. Shows path-based routing with priorities and custom health check configurations.

```ts
const vpc = new sst.aws.Vpc("MyVpc");
const cluster = new sst.aws.Cluster("MyCluster", { vpc });

// Create a shared ALB with an HTTP listener
const alb = new sst.aws.Alb("SharedAlb", {
  vpc,
  listeners: [{ port: 80, protocol: "http" }],
});

// API service — handles /api/* with a custom health check path
new sst.aws.Service("Api", {
  cluster,
  image: { context: "api/" },
  loadBalancer: {
    instance: alb,
    rules: [
      {
        listen: "80/http",
        forward: "3000/http",
        conditions: { path: "/api/*" },
        priority: 100,
      },
    ],
    health: {
      "3000/http": {
        path: "/api/health",
        interval: "10 seconds",
        timeout: "5 seconds",
        healthyThreshold: 2,
        unhealthyThreshold: 3,
      },
    },
  },
});

// Web service — handles everything else under /app/*
new sst.aws.Service("Web", {
  cluster,
  image: { context: "web/" },
  loadBalancer: {
    instance: alb,
    rules: [
      {
        listen: "80/http",
        forward: "3000/http",
        conditions: { path: "/app/*" },
        priority: 200,
      },
    ],
    health: {
      "3000/http": {
        path: "/app/health",
        interval: "10 seconds",
        timeout: "5 seconds",
      },
    },
  },
});
```

--------------------------------

### Customize autodeploy workflow

Source: https://sst.dev/docs/reference/config

Customize the autodeploy workflow. The workflow function receives $ and event, and can run commands. This example installs pnpm, installs dependencies, and then removes or deploys based on the event action.

```ts
{
  autodeploy: {
    async workflow({ $, event }) {
      await $`npm i -g pnpm`;
      await $`pnpm i`;
      event.action === "removed"
        ? await $`pnpm sst remove`
        : await $`pnpm sst deploy`;
    }
  }
}

```

--------------------------------

### Exclude dependencies from bundle with install

Source: https://sst.dev/docs/component/aws/function

Use the `install` option to exclude npm packages from the esbuild bundle. They are moved into a `node_modules/` directory in the function package. This example pins `pg` to version `8.13.1`.

```javascript
{
  nodejs: {
    install: { pg: "8.13.1" }
  }
}
```

--------------------------------

### Create SolidStart project

Source: https://sst.dev/docs/start/aws/solid

Initializes a new SolidStart project named 'aws-solid-container' and navigates into it. Select the SolidStart, basic, and TypeScript options.

```bash
npm init solid@latest aws-solid-container
cd aws-solid-container

```

--------------------------------

### Create a new Bun project

Source: https://sst.dev/docs/start/aws/bun

Creates a new directory and initializes a Bun project.

```bash
mkdir aws-bun && cd aws-bun
bun init -y

```

--------------------------------

### Share cluster across stages using static get

Source: https://sst.dev/docs/component/aws/cluster

Example of using the static get method to share a cluster from the dev stage in a personal stage, avoiding creation of a new cluster.

```ts
const cluster = $app.stage === "frank"
  ? sst.aws.Cluster.get("MyCluster", {
      id: "arn:aws:ecs:us-east-1:123456789012:cluster/app-dev-MyCluster",
      vpc,
    })
  : new sst.aws.Cluster("MyCluster", { vpc });
```

--------------------------------

### Create a Python function

Source: https://sst.dev/docs/component/aws/function

Minimal example for Python functions. Requires uv installed and the handler in a uv workspace.

```ts
new sst.aws.Function("MyFunction", {
  runtime: "python3.13",
  handler: "functions/src/functions/api.handler"
});
```

--------------------------------

### Initialize an SST app with sst init

Source: https://sst.dev/docs/basics

Initializes a new SST app. Run this before using the other commands.

```bash
sst init

```

--------------------------------

### Single-region cluster with static get

Source: https://sst.dev/docs/component/aws/dsql

Example of using the static get method to reference a single-region cluster, conditionally based on the stage. If the stage is 'frank', it retrieves an existing cluster by ID; otherwise, it creates a new one.

```ts
const cluster = $app.stage === "frank"
  ? sst.aws.Dsql.get("MyCluster", { id: "kzttrvbdg4k2o5ze2m2rrwdj7u" })
  : new sst.aws.Dsql("MyCluster");
```

--------------------------------

### Initialize SST

Source: https://sst.dev/docs/start/aws/bun

Initializes SST in the project and installs dependencies.

```bash
bunx sst init
bun install

```

--------------------------------

### Share Identity Pool across stages using static get

Source: https://sst.dev/docs/component/aws/cognito-identity-pool

Example in sst.config.ts that conditionally uses the static get method to share the Identity Pool from the dev stage in the frank stage, or creates a new one otherwise.

```ts
const identityPool = $app.stage === "frank"
  ? sst.aws.CognitoIdentityPool.get("MyIdentityPool", "us-east-1:02facf30-e2f3-49ec-9e79-c55187415cf8")
  : new sst.aws.CognitoIdentityPool("MyIdentityPool");
```

--------------------------------

### Output cluster ID

Source: https://sst.dev/docs/component/aws/aurora

Example in `sst.config.ts` that returns the cluster ID, which can be used to find the ID for the `static get` method.

```ts
return database.id;
```

--------------------------------

### Initialize Bun Elysia project with SST

Source: https://sst.dev/docs/examples/aws-bun-elysia

Initializes a new Bun Elysia project and SST in the project directory.

```bash
bun create elysia aws-bun-elysia
cd aws-bun-elysia
bunx sst init

```

--------------------------------

### .env file example

Source: https://sst.dev/docs/reference/config

Example .env file defining an environment variable. The .env file takes precedence over .env.<stage> files.

```bash
MY_ENV_VAR=hello
```

--------------------------------

### sst CLI: Show global help

Source: https://sst.dev/docs/reference/cli

Prints global help for the CLI.

```sh
sst --help

```

--------------------------------

### SST infrastructure for Astro app

Source: https://sst.dev/docs/examples/aws-astro-stream

Creates an SST Astro app with the name "MyWeb". This is the infrastructure setup for the streaming example.

```ts
new sst.aws.Astro("MyWeb");

```

--------------------------------

### Customize bundling with build property

Source: https://sst.dev/docs/component/cloudflare/worker

Customizes how SST uses esbuild to bundle the worker code with the `build` property. The example installs the `pg` package.

```ts
new sst.cloudflare.Worker("MyWorker", {
  handler: "src/worker.handler",
  build: {
    install: ["pg"]
  }
});
```

--------------------------------

### Start dev mode and view output

Source: https://sst.dev/docs/start/aws/drizzle

Starts the app in dev mode, running functions Live. It takes a few minutes to create the database, then shows a completion message with the API URL. Drizzle Studio and a tunnel are started in separate tabs.

```bash
npx sst dev
```

```bash
✓  Complete
   MyApi: https://ouu5vovpxllyn5b6ot2nn6vdsa0hvcuj.lambda-url.us-east-1.on.aws
```

--------------------------------

### Initialize SST

Source: https://sst.dev/docs/start/aws/angular

Run SST init to create the sst.config.ts file in the project root.

```bash
npx sst@latest init

```

--------------------------------

### Set environment variables

Source: https://sst.dev/docs/component/cloudflare/tan-stack-start

Example of setting environment variables for the TanStack Start app. These are available in the build, at runtime as Worker bindings, and locally in dev.

```js
{
  environment: {
    API_URL: api.url,
    PUBLIC_STRIPE_PUBLISHABLE_KEY: "pk_test_123"
  }
}
```

--------------------------------

### StepFunctions.task usage

Source: https://sst.dev/docs/component/aws/step-functions

Example of using the task state to start an AWS CodeBuild build. Specifies the resource ARN, arguments, and required IAM permissions.

```ts
sst.aws.StepFunctions.task({
  name: "Task",
  resource: "arn:aws:states:::codebuild:startBuild",
  arguments: {
    projectName: "my-codebuild-project"
  },
  permissions: [
    {
      actions: ["codebuild:StartBuild"],
      resources: ["*"]
    }
  ]
});
```

--------------------------------

### Specify provider version in sst.config.ts

Source: https://sst.dev/docs/reference/cli

Example of specifying a specific version for the AWS provider in sst.config.ts. You'll need to run 'sst install' after updating the providers.

```ts
{
  providers: {
    aws: {
      package: "@pulumi/aws",
      version: "6.26.0"
    }
  }
}

```

--------------------------------

### Serve SolidStart app from a path via Router

Source: https://sst.dev/docs/component/aws/solid-start

Serve the SolidStart app from a path (e.g., /docs) through a Router. Configure the root domain in the Router, set the router and path in the SolidStart component, and set the baseURL in app.config.ts without a trailing slash. The baseURL must match the path.

```ts
const router = new sst.aws.Router("Router", {
  domain: "example.com"
});
```

```ts
{
  router: {
    instance: router,
    path: "/docs"
  }
}
```

```js
export default defineConfig({
  server: { preset: "aws-lambda" },
  baseURL: "/docs"
});
```

--------------------------------

### buildCommand example

Source: https://sst.dev/docs/component/aws/nuxt

Use a custom build command for the Nuxt app.

```javascript
{
  buildCommand: "yarn build"
}
```

--------------------------------

### Output database ID and proxy ID

Source: https://sst.dev/docs/component/aws/mysql

Return the database ID and proxy ID from the dev stage to find the values used in the static get example.

```ts
return {
  id: database.id,
  proxyId: database.proxyId
};
```

--------------------------------

### CLI output for bucket name

Source: https://sst.dev/docs/reference/config

Example output displayed in the CLI after running `sst deploy` or `sst dev` for the `run` function example.

```bash
bucket: bucket-jOaikGu4rla
```

--------------------------------

### Share EFS across stages with static get

Source: https://sst.dev/docs/component/aws/efs

Example in sst.config.ts showing how to conditionally use the static get method to share an EFS file system from the dev stage when the current stage is 'frank', otherwise create a new one. The ID 'app-dev-myefs' is the file system ID from the dev stage.

```ts
const efs = $app.stage === "frank"
  ? sst.aws.Efs.get("MyEfs", "app-dev-myefs")
  : new sst.aws.Efs("MyEfs", { vpc });
```

--------------------------------

### Create a Node.js project

Source: https://sst.dev/docs/start/aws/drizzle

Creates a new project directory and initializes a Node.js app with default settings.

```bash
mkdir aws-drizzle && cd aws-drizzle
npm init -y

```

--------------------------------

### Set banner for generated JS file

Source: https://sst.dev/docs/component/aws/function

Use the `banner` option to insert a string at the beginning of the generated JS file. This example logs 'Function starting' when the function is invoked.

```javascript
{
  nodejs: {
    banner: "console.log('Function starting')"
  }
}
```

--------------------------------

### Function components with and without explicit runtime

Source: https://sst.dev/docs/components

Example of two Function components created after the `$transform` call. `MyFunctionA` gets the default runtime `nodejs18.x`, while `MyFunctionB` overrides it with `nodejs20.x`.

```ts
new sst.aws.Function("MyFunctionA", {
  handler: "src/lambdaA.handler"
});

new sst.aws.Function("MyFunctionB", {
  handler: "src/lambdaB.handler",
  runtime: "nodejs20.x"
});

```

--------------------------------

### Create a Remix project

Source: https://sst.dev/docs/start/aws/remix

Initializes a new Remix app in the aws-remix-container directory and navigates into it. Accepts all default options.

```bash
npx create-remix@latest aws-remix-container
cd aws-remix-container

```

--------------------------------

### nodejs.banner: Insert string at start of generated JS

Source: https://sst.dev/docs/component/aws/workflow

Inserts a string at the beginning of the generated JS file. Use this to add logging or other setup code that runs before the function body.

```js
{
  nodejs: {
    banner: "console.log('Function starting')"
  }
}

```

--------------------------------

### Dockerfile for Express app with Prisma

Source: https://sst.dev/docs/start/aws/prisma

Creates a Docker image for the Express app, copying package.json, index.mjs, and the prisma directory, installing dependencies, and running prisma generate before starting the app.

```dockerfile
FROM node:18-bullseye-slim

WORKDIR /app/

COPY package.json index.mjs prisma /app/
RUN npm install

RUN npx prisma generate

ENTRYPOINT ["node", "index.mjs"]

```

--------------------------------

### Share Redis cluster across stages

Source: https://sst.dev/docs/component/aws/redis

Example of using static get to share a Redis cluster across stages. In the 'frank' stage, it references the cluster created in 'dev' with ID 'app-dev-myredis'.

```ts
const redis = $app.stage === "frank"
  ? sst.aws.Redis.get("MyRedis", "app-dev-myredis")
  : new sst.aws.Redis("MyRedis");
```

--------------------------------

### Capacity example: 50/50 with base 2

Source: https://sst.dev/docs/component/aws/service

Example setting: use 50% regular Fargate and 50% Fargate Spot, ensuring the first 2 tasks use regular Fargate.

```js
{
  capacity: {
    fargate: { weight: 1, base: 2 },
    spot: { weight: 1 }
  }
}
```

--------------------------------

### new TanStackStart(name, args?, opts?)

Source: https://sst.dev/docs/component/aws/tan-stack-start

Creates a new TanStackStart component instance. This is the constructor for the component, which takes a name, optional configuration arguments, and optional component resource options.

```APIDOC
## new TanStackStart(name, args?, opts?)

### Description
Creates a new TanStackStart component instance. This is the constructor for the component, which takes a name, optional configuration arguments, and optional component resource options.

### Parameters
- `name` (string) - Required - The name of the component.
- `args?` (TanStackStartArgs) - Optional - Configuration arguments for the component.
- `opts?` (ComponentResourceOptions) - Optional - Pulumi component resource options.

### Example
```ts
new TanStackStart("my-app", { assets: { textEncoding: "utf-8" } });
```
```
Tokens:
Raw