Skip to main content
The Postgres component lets you add a Postgres database to your app using Amazon RDS Postgres.

Constructor

sst.config.ts
const database = new sst.aws.Postgres("MyDatabase");

Parameters

vpc

vpc
Vpc
required
The VPC to place the database in.
{
  vpc: myVpc
}

version

version
string
default:"16.3"
The Postgres version.
{
  version: "15.4"
}

instance

instance
string
default:"t4g.micro"
The database instance type.
{
  instance: "t4g.small"
}

Properties

host

port

database

username

password

SDK

Access the database connection info:
src/lambda.ts
import { Resource } from "sst";

console.log(Resource.MyDatabase.host);
console.log(Resource.MyDatabase.port);

Examples

Create a Postgres database

sst.config.ts
const vpc = new sst.aws.Vpc("MyVpc");
const database = new sst.aws.Postgres("MyDatabase", { vpc });
sst.config.ts
const vpc = new sst.aws.Vpc("MyVpc");
const database = new sst.aws.Postgres("MyDatabase", { vpc });

new sst.aws.Function("MyFunction", {
  handler: "src/lambda.handler",
  link: [database],
  vpc
});

Build docs developers (and LLMs) love