Skip to main content
The Astro component lets you deploy Astro sites on AWS.

​
Constructor

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

​
Parameters

​
path

​
path
string
default:"."
Path to the Astro site directory relative to sst.config.ts.
{
  path: "packages/web"
}

​
domain

​
domain
string | object
Set a custom domain for your Astro site.
{
  domain: "example.com"
}
​
link
array
Link resources to your Astro site.
{
  link: [bucket, stripeKey]
}

​
environment

​
environment
Record<string, string>
Set environment variables for your Astro site.
{
  environment: {
    API_URL: api.url,
    PUBLIC_STRIPE_KEY: "pk_test_123"
  }
}
Prefix with PUBLIC_ to access variables on the client-side.

​
Properties

​
url

​
nodes

​
SDK

Access linked resources:
src/pages/index.astro
import { Resource } from "sst";

console.log(Resource.MyBucket.name);

​
Examples

​
Change the path

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

​
Add a custom domain

sst.config.ts
new sst.aws.Astro("MyWeb", {
  domain: "my-site.com"
});
sst.config.ts
const bucket = new sst.aws.Bucket("MyBucket");

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

Build docs developers (and LLMs) love

Get started for freeTalk to us