Remix

Reference doc for the sst.aws.Remix component.

The Remix component lets you deploy Remix apps on AWS.

Constructor

sst.config.ts

new sst.aws.Remix("MyWeb");

Parameters

path

path · string · default: "."

Path to the Remix app directory relative to sst.config.ts.

{
  path: "packages/web"
}

domain

domain · string | object

Set a custom domain for your Remix app.

{
  domain: "example.com"
}

Redirect www to apex domain:

{
  domain: {
    name: "example.com",
    redirects: ["www.example.com"]
  }
}

link

link · array

Link resources to your Remix app.

{
  link: [bucket, stripeKey]
}

environment

environment · Record<string, string>

Set environment variables for your Remix app.

{
  environment: {
    API_URL: api.url
  }
}

Properties

url

nodes

SDK

Access linked resources:

app/routes/_index.tsx

import { Resource } from "sst";

console.log(Resource.MyBucket.name);

Examples

Change the path

sst.config.ts

new sst.aws.Remix("MyWeb", {
  path: "packages/web"
});

Add a custom domain

sst.config.ts

new sst.aws.Remix("MyWeb", {
  domain: "my-app.com"
});

Link resources

sst.config.ts

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

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