SDK

The JS SDK is an npm package that you can use in your runtime code to interact with your infrastructure.

You can use the SDK in your functions, frontends, and container applications. You can access links from components in a typesafe way. And some components come with SDK clients that you can use.

Tip

Check out the SDK section in a component’s API reference doc.

Currently, the SDK is only available for JavaScript and TypeScript. Support for other languages is coming soon.

---

Installation

Install the npm package.

npm install sst

---

Links

Import Resource to access the linked resources.

src/lambda.ts

import { Resource } from "sst";

console.log(Resource.MyBucket.name);

Tip

The Resource object is typesafe and will autocomplete the available resources in your editor.

Here we are assuming that a bucket has been linked to the function. Here’s what that could look like.

sst.config.ts

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

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

---

Defaults

By default, the Resource object contains Resource.App. This gives you some info about the current app including:

• App.name: The name of your SST app.
• App.stage: The current stage of your SST app.

src/lambda.ts

import { Resource } from "sst";

console.log(Resource.App.name, Resource.App.stage);

---

How it works

In the above example, Resource.MyBucket.name works because it’s been injected into the function package on sst dev and sst deploy.

For functions, this is injected into the globalThis using esbuild and for frontends, it’s injected into the process.env object.

The JS SDK first checks the process.env and then the globalThis for the linked resources. You can read more about how the links are injected.

---

Client

Components like the Realtime component come with a client that you can use.

import { realtime } from "sst/aws/realtime";

export const handler = realtime.authorizer(async (token) => {
  // Validate the token
});

For example, realtime.authorizer lets you create the handler for the authorizer function that Realtime needs.