SST v2

https://v2.sst.dev
Admin
SST is a framework that simplifies building modern full-stack serverless applications on AWS,...
Tokens:412,764
Snippets:5,679
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Installing Static Site Environment Package

Source: https://v2.sst.dev/constructs/v0/StaticSite

Install the necessary package to use environment variables during local development with `sst start`.

```bash
npm install --save-dev @serverless-stack/static-site-env

```

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

### Create a new SST project with a template

Source: https://v2.sst.dev/packages/create-sst

Instead of the standard starter, you can choose to use one of our minimal setups or examples as the template to bootstrap your project.

```bash
npx create-sst@two --template=other/go  
```

```bash
yarn create sst@two --template=other/go  
```

```bash
pnpm create sst@two --template=other/go  
```

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

### Start SvelteKit Site Locally

Source: https://v2.sst.dev/constructs/SvelteKitSite

After starting SST, run this command to start your SvelteKit site locally. This command is typically bound by SST.

```bash
npm run dev  

```

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

### Example: Bind container service

Source: https://v2.sst.dev/packages/sst

Start your container service with all bound resources and environment variables from your SST app. `sst bind` detects `Service` constructs linked to the current directory.

```bash
npx sst bind node app.js
```

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

### Start Frontend with npm

Source: https://v2.sst.dev/learn/start-the-frontend

Run this command in your project root to start the frontend using npm.

```bash
cd packages/web
npm run dev

```

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

### Start Frontend with pnpm

Source: https://v2.sst.dev/learn/start-the-frontend

Run this command in your project root to start the frontend using pnpm.

```bash
cd packages/web
pnpm run dev

```

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

### Start Frontend with yarn

Source: https://v2.sst.dev/learn/start-the-frontend

Run this command in your project root to start the frontend using yarn.

```bash
cd packages/web
yarn run dev

```

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

### Starting the Development Server

Source: https://v2.sst.dev/constructs/v0/StaticSite

Run your application locally using the configured start script to access environment variables provided by SST.

```bash
npm run start

```

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

### Install Dependencies with npm

Source: https://v2.sst.dev/learn/create-a-new-project

Navigate to your new app directory and install dependencies using npm.

```bash
cd my-sst-app  
npm install  
```

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

### Install Dependencies with yarn

Source: https://v2.sst.dev/learn/create-a-new-project

Navigate to your new app directory and install dependencies using yarn.

```bash
cd my-sst-app  
yarn  
```

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

### Install Dependencies with pnpm

Source: https://v2.sst.dev/learn/create-a-new-project

Navigate to your new app directory and install dependencies using pnpm.

```bash
cd my-sst-app  
pnpm install  
```

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

### Example Dockerfile for Node.js App

Source: https://v2.sst.dev/constructs/Service

A basic Dockerfile for a Node.js Express application. It copies the project files, installs dependencies, and sets the entrypoint to start the Express server.

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

COPY . /app
WORKDIR /app/

RUN npm install

ENTRYPOINT ["node", "app.mjs"]
```

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

### Create RDS with Minimal Configuration

Source: https://v2.sst.dev/constructs/RDS

Instantiate an RDS database with the essential configuration. This is the simplest way to get started.

```typescript
import { RDS } from "sst/constructs";

new RDS(stack, "Database", {
  engine: "postgresql11.13",
  defaultDatabaseName: "my_database",
});
```

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

### MySQL Migration Example

Source: https://v2.sst.dev/constructs/v0/RDS

Example of a MySQL migration script to create a 'person' table.

```javascript
async function up(db) {  
  await db.schema  
    .createTable("person")  
    .addColumn("id", "integer", (col) => col.autoIncrement().primaryKey())
    .addColumn("first_name", "varchar(255)", (col) => col.notNull())
    .addColumn("last_name", "varchar(255)")  
    .addColumn("gender", "varchar(50)", (col) => col.notNull())
    .execute()
}
  
async function down(db) {  
  await db.schema.dropTable("person").execute()
}
  
module.exports = { up, down };  

```

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

### Start Astro Site with SST Bind

Source: https://v2.sst.dev/constructs/AstroSite

After starting SST, run this command to start your Astro site, binding it to the SST environment.

```bash
npm run dev  
```

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

### Install SST Node Client (yarn)

Source: https://v2.sst.dev/clients

Install the SST Node client using yarn. Use the --exact flag to ensure a specific version is installed.

```bash
yarn add sst@two --exact  


```

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

### Start Local Development with a Specific AWS Profile

Source: https://v2.sst.dev/working-with-your-team

Use this command to start SST locally, specifying the AWS profile for the dev environment. This is useful when using a single AWS account per environment setup.

```bash
AWS_PROFILE=dev-profile npx sst dev  

```

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

### Install SST CLI (pnpm)

Source: https://v2.sst.dev/packages/sst

Install the SST CLI using pnpm. Use the `@two` tag to install the latest v2 release.

```bash
pnpm add sst@two --save-exact  
```

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

### Install SST CLI (npm)

Source: https://v2.sst.dev/packages/sst

Install the SST CLI using npm. Use the `@two` tag to install the latest v2 release.

```bash
npm install sst@two --save-exact  
```

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

### PostgreSQL Migration Example

Source: https://v2.sst.dev/constructs/v0/RDS

Example of a PostgreSQL migration script to create a 'person' table.

```javascript
async function up(db) {  
  await db.schema  
    .createTable("person")  
    .addColumn("id", "serial", (col) => col.primaryKey())
    .addColumn("first_name", "varchar", (col) => col.notNull())
    .addColumn("last_name", "varchar")  
    .addColumn("gender", "varchar(50)", (col) => col.notNull())
    .execute()
}
  
async function down(db) {  
  await db.schema.dropTable("person").execute()
}
  
module.exports = { up, down };  

```

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

### Esbuild Plugins File Example

Source: https://v2.sst.dev/constructs/v0/Function

Example of an esbuild configuration file exporting an array of esbuild plugins.

```javascript
const { esbuildDecorators } = require("@anatine/esbuild-decorators");

module.exports = [
  esbuildDecorators(),
];
```

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

### Running sst start

Source: https://v2.sst.dev/constructs/v0/StaticSite

Use the `sst start` command to initiate the Live Lambda Development environment, which prepares environment variables for local use.

```bash
npx sst start

```

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

### Install SST CLI and Resources

Source: https://v2.sst.dev/constructs/v1

Install the necessary packages for SST CLI and resources. Ensure the versions are kept in sync.

```bash
npm install @serverless-stack/cli @serverless-stack/resources --save-exact
```

```bash
yarn add @serverless-stack/cli @serverless-stack/resources --exact
```

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

### Start Remix dev server with pnpm

Source: https://v2.sst.dev/start/remix

Use this command to start the Remix development server using pnpm.

```bash
pnpm run dev  
```

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

### Example: Bind with --script option

Source: https://v2.sst.dev/packages/sst

When using `sst bind` within a frontend directory but not starting the frontend itself, use the `--script` option. This is useful for running scripts like `npm run build`.

```bash
npx sst bind --script npm run build
```

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

### Queue Examples

Source: https://v2.sst.dev/constructs/v0/Queue

Provides various examples of using the Queue construct, including minimal configuration, lazy consumer addition, permission attachment, FIFO queue creation, and advanced configuration.

```APIDOC
## Queue Examples

### Using the minimal config
```typescript
new Queue(this, "Queue", {
  consumer: "src/queueConsumer.main",
});
```

### Lazily adding consumer
```typescript
const queue = new Queue(this, "Queue");
queue.addConsumer(this, "src/queueConsumer.main");
```

### Giving the consumer some permissions
```typescript
const queue = new Queue(this, "Queue", {
  consumer: "src/queueConsumer.main",
});
queue.attachPermissions(["s3"]);
```

### Creating a FIFO queue
```typescript
new Queue(this, "Queue", {
  consumer: "src/queueConsumer.main",
  sqsQueue: {
    fifo: true,
  },
});
```

### Configuring the SQS queue
```typescript
import { Duration } from "aws-cdk-lib";

new Queue(this, "Queue", {
  consumer: "src/queueConsumer.main",
  sqsQueue: {
    queueName: "my-queue",
    visibilityTimeout: Duration.seconds(5),
  },
});
```

### Configuring the consumer
#### Configuring the function props
```typescript
new Queue(this, "Queue", {
  consumer: {
    function: {
      handler: "src/queueConsumer.main",
      timeout: 10,
      environment: { bucketName: bucket.bucketName },
      permissions: [bucket],
    },
  },
});
```

#### Configuring the consumption props
```typescript
new Queue(this, "Queue", {
  consumer: {
    function: "src/queueConsumer.main",
    consumerProps: {
      batchSize: 5,
    },
  },
});
```

### Importing an existing queue
```typescript
import { Queue } from "aws-cdk-lib/aws-sqs";

new Queue(this, "Queue", {
  consumer: "src/queueConsumer.main",
  sqsQueue: Queue.fromQueueArn(this, "MySqsQueue", queueArn),
});
```
```

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

### Install SST CLI (yarn)

Source: https://v2.sst.dev/packages/sst

Install the SST CLI using yarn. Use the `@two` tag to install the latest v2 release.

```bash
yarn add sst@two --exact  
```

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

### Start Remix dev server with yarn

Source: https://v2.sst.dev/start/remix

Use this command to start the Remix development server using yarn.

```bash
yarn run dev  
```

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

### Start Local Development with Personal AWS Profile and Dev Stage

Source: https://v2.sst.dev/working-with-your-team

Initiate local SST development using your personal AWS profile and specifying 'dev' as the stage. This is part of the setup where each developer has their own AWS account.

```bash
AWS_PROFILE=personal-profile npx sst dev --stage dev  

```

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

### Start local SST development environment

Source: https://v2.sst.dev/start/svelte

Start your local dev environment for SST using npm, yarn, or pnpm.

```bash
npx sst dev  
```

```bash
yarn sst dev  
```

```bash
pnpm sst dev  
```

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

### Start SST Dev Server

Source: https://v2.sst.dev/constructs/AstroSite

Run this command in your project root to start the SST development server.

```bash
npx sst dev  
```

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

### Install npm package

Source: https://v2.sst.dev/advanced/lambda-layers

Install the 'sharp' package in your application. This is the first step when packaging your own node_modules into a Lambda Layer.

```bash
npm install sharp  
```

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

### Install AWS SDK

Source: https://v2.sst.dev/resource-binding

Install the necessary AWS SDK packages for S3 client and request presigner to interact with AWS services.

```bash
npm install --save @aws-sdk/client-s3 @aws-sdk/s3-request-presigner  
```

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

### Start Local Development Environment

Source: https://v2.sst.dev/packages/sst

Start a local development environment for Lambda functions using `sst dev`. This enables Live Lambda Dev for testing changes without deployment.

```bash
npx sst dev [options]  
```

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

### Total Warming Cost Example

Source: https://v2.sst.dev/constructs/SvelteKitSite

This example demonstrates how to calculate the approximate monthly cost of keeping a specific number of server function instances warm.

```text
$0.00864 + $0.145728288 + $0.0161280288 x 50 = $0.960769728
```

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

### Install SST Node Client (npm)

Source: https://v2.sst.dev/clients

Install the SST Node client using npm. Ensure you use the exact version for consistency.

```bash
npm install sst@two --save-exact  


```

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

### Start SST Dev

Source: https://v2.sst.dev/constructs/SvelteKitSite

Run this command in your project root to start SST in development mode.

```bash
npx sst dev  

```

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

### Start local dev environment with pnpm

Source: https://v2.sst.dev/start/remix

Run this command to start the local development environment for your SST project using pnpm.

```bash
pnpm sst dev  
```

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

### Add GET route for GraphQL API

Source: https://v2.sst.dev/upgrade-guide

When using the Api construct with a 'graphql' route type, you can define both GET and POST routes. This example shows how to add a GET route.

```typescript
new Api(stack, "api", {
  routes: {
    "GET /": {
      type: "graphql",
      function: "src/graphql.handler",
    },
    "POST /": {
      type: "graphql",
      function: "src/graphql.handler",
    }
  }
});
```

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

### Install @sls-next/lambda-at-edge

Source: https://v2.sst.dev/constructs/v1/NextjsSite

To use the NextjsSite construct, you must install the `@sls-next/lambda-at-edge` package as a dependency in your project's package.json.

```bash
npm install --save @sls-next/lambda-at-edge  

```

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

### Starting React App with npm

Source: https://v2.sst.dev/constructs/v0/ReactStaticSite

Starts the React application using the configured npm script, which includes environment variable injection.

```bash
npm run start
```

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

### Install SST Node Client (pnpm)

Source: https://v2.sst.dev/clients

Install the SST Node client using pnpm. The --save-exact flag ensures the exact version is recorded.

```bash
pnpm add sst@two --save-exact  


```

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

### getFunction

Source: https://v2.sst.dev/constructs/Api

Get the instance of the internally created Function, for a given route key. The `routeKey` is the key used to define a route, for example, `GET /notes`.

```APIDOC
## getFunction

### Description
Get the instance of the internally created Function, for a given route key. The `routeKey` is the key used to define a route, for example, `GET /notes`.

### Method Signature
`getFunction(routeKey)`

### Parameters
* **routeKey** string

### Example
```typescript
const api = new Api(stack, "Api", {
  routes: {
    "GET /notes": "src/list.main",
  },
});

const listFunction = api.getFunction("GET /notes");
```
```

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

### Create a New SolidStart App

Source: https://v2.sst.dev/constructs/SolidStartSite

Use this command to create a new SolidStart app. Ensure Server Side Rendering is enabled during setup.

```bash
npx create-solid@latest  

```

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

### Installing static-site-env Package

Source: https://v2.sst.dev/constructs/v1/RemixSite

Install the `@serverless-stack/static-site-env` package as a dev dependency to enable environment variable support in your Remix app during local development.

```bash
npm install --save-dev @serverless-stack/static-site-env  

```

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

### Instantiate Auth Construct

Source: https://v2.sst.dev/constructs/Auth

Example of how to instantiate the Auth construct with an authenticator function. This is a common setup for enabling authentication.

```typescript
const api = new Api(stack, "Api", {});
const auth = new Auth(stack, "Auth", {
  authenticator: "functions/authenticator.handler"
})
auth.attach(stack, {
  api
})
```

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

### Install Datadog Packages with npm

Source: https://v2.sst.dev/advanced/monitoring

Install the Datadog CDK construct, APM tracer, and Lambda-specific tracer as development dependencies using npm.

```bash
npm install --save-dev datadog-cdk-constructs-v2 dd-trace datadog-lambda-js  

```

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

### Dockerfile for Container Job

Source: https://v2.sst.dev/constructs/Job

Example Dockerfile for a container job. It specifies the base image, installs dependencies, and copies the script.

```dockerfile
# Start from Python 3.8 base image
FROM python:3.8-slim

# Install the dependencies
COPY requirements.txt .
RUN pip3 install -r requirements.txt --target /var/task

# Copy our function code
COPY my-script.py /var/task


```

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

### getRoute

Source: https://v2.sst.dev/constructs/WebSocketApi

Get the instance of the internally created Route, for a given route key where the `routeKey` is the key used to define a route. For example, `$connect` .

```APIDOC
## getRoute

### Description
Get the instance of the internally created Route, for a given route key where the `routeKey` is the key used to define a route. For example, `$connect` .

### Method
```
getRoute(routeKey)
```

### Parameters
* **routeKey** string

### Request Example
```
const route = api.getRoute("$connect");
```
```

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

### getFunction

Source: https://v2.sst.dev/constructs/WebSocketApi

Get the instance of the internally created Function, for a given route key where the `routeKey` is the key used to define a route. For example, `$connect` .

```APIDOC
## getFunction

### Description
Get the instance of the internally created Function, for a given route key where the `routeKey` is the key used to define a route. For example, `$connect` .

### Method
```
getFunction(routeKey)
```

### Parameters
* **routeKey** string

### Request Example
```
const fn = api.getFunction("$connect");
```
```

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

### Bind Method Example

Source: https://v2.sst.dev/constructs/Cron

Example of using the `bind` method to associate resources like environment variables or buckets with the cron job.

```typescript
cron.bind([STRIPE_KEY, bucket]);
```

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

### Deploy from pre-built output

Source: https://v2.sst.dev/packages/sst

Use the `--from` option with `sst deploy` to deploy from a pre-built output directory. This is useful for deploying without rebuilding the app.

```bash
npx sst deploy --from <path>
```

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

### Minimal AppSyncApi Configuration

Source: https://v2.sst.dev/constructs/AppSyncApi

This snippet shows the basic setup for an AppSyncApi construct, defining the schema, data sources, and resolvers. Ensure 'graphql' and '@graphql-tools/merge' are installed.

```typescript
import { AppSyncApi } from "sst/constructs";

new AppSyncApi(stack, "GraphqlApi", {
  schema: "graphql/schema.graphql",
  dataSources: {
    notesDS: "src/notes.main",
  },
  resolvers: {
    "Query    listNotes": "notesDS",
    "Query    getNoteById": "notesDS",
    "Mutation createNote": "notesDS",
    "Mutation updateNote": "notesDS",
    "Mutation deleteNote": "notesDS",
  },
});

```

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

### Create a new SST app with npm

Source: https://v2.sst.dev/start/standalone

Use this command to initialize a new SST project using npm.

```bash
npx create-sst@two my-sst-app  

```

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

### Get SST and CDK versions

Source: https://v2.sst.dev/packages/sst

Print the version of SST your app is using, along with the internally used CDK version. Ensure consistency when installing additional CDK packages.

```bash
npx sst version
```

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

### Start App with sst bind

Source: https://v2.sst.dev/constructs/Service

Navigate to your service directory and run your app using `sst bind` to load service resources, environment variables, and IAM permissions.

```bash
cd service  
npx sst bind node app.mjs  
```

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

### StaticSite File Options Example

Source: https://v2.sst.dev/constructs/v0/StaticSite

Configure cache control for specific file types using file options. This example sets immutable caching for all .js files.

```typescript
{
  exclude: "*",
  include: "*.js",
  cacheControl: "max-age=31536000,public,immutable",
}
```

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

### Configure AWS SSO Session in ~/.aws/config

Source: https://v2.sst.dev/setting-up-aws

Defines the SSO session parameters, including the SSO start URL and region. Ensure the URL and region match your IAM Identity Center setup.

```ini
[sso-session acme]
sso_start_url = https://acme.awsapps.com/start
sso_region = us-east-1
```

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

### Configure Custom Domain for Vite App

Source: https://v2.sst.dev/constructs/v0/ViteStaticSite

Configures a custom domain for the Vite static site. Supports domains hosted on Route 53 or externally. This example shows a basic Route 53 setup.

```typescript
new ViteStaticSite(this, "Site", {
  path: "path/to/src",
  customDomain: "domain.com",
});
```

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

### Starting Vite App with npm Script

Source: https://v2.sst.dev/constructs/StaticSite

Run your Vite application using the configured npm script (e.g., 'npm run dev') to start the development server with environment variables bound by 'sst bind'.

```bash
npm run dev  


```

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

### Initialize SST in Astro Project with npm

Source: https://v2.sst.dev/start/astro

Navigate to your Astro project directory and initialize SST using npm.

```bash
cd astro-project  
npx create-sst@two  
```

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

### Example: Bind Next.js dev server

Source: https://v2.sst.dev/packages/sst

Launch your Next.js development server with all bound resources and environment variables from your SST app. `sst bind` automatically detects frontend constructs like `NextjsSite` in the current directory.

```bash
npx sst bind next dev
```

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

### Create SolidStart App (npm)

Source: https://v2.sst.dev/start/solid

Use this command to create a new SolidStart application using npm.

```bash
npx create-solid@latest  
```

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

### Install @serverless-stack/static-site-env Package

Source: https://v2.sst.dev/constructs/v0/ViteStaticSite

Installs the necessary package for referencing SST environment variables within your Vite app during development. Use npm or yarn to install.

```bash
npm install --save-dev @serverless-stack/static-site-env
```

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

### Install SolidStart SST Adapter

Source: https://v2.sst.dev/constructs/SolidStartSite

Add the solid-start-sst dependency to your SolidStart app's package.json.

```bash
npm install --save-dev solid-start-sst  

```

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

### Configure Python Install Commands

Source: https://v2.sst.dev/constructs/Function

Use `installCommands` to specify custom commands for installing Python dependencies. This is useful for private package indexes or complex installation requirements.

```typescript
new Function(stack, "Function", {
  python: {
    installCommands: [
      'export VARNAME="my value"',
      'pip install --index-url https://domain.com/pypi/myprivatemodule/simple/ --extra-index-url https://pypi.org/simple -r requirements.txt .',
    ]
  }
})
```

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

### Deploy SolidStart App to Production

Source: https://v2.sst.dev/start/solid

Use these commands to deploy your SolidStart application to a production environment using npm, yarn, or pnpm.

```bash
npx sst deploy --stage prod
```

```bash
yarn sst deploy --stage prod
```

```bash
pnpm sst deploy --stage prod
```

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

### Configure Python Lambda with Custom Install Commands

Source: https://v2.sst.dev/constructs/v1/Function

Set up a Python Lambda function with custom commands to install dependencies, useful for private package repositories or specific installation steps.

```typescript
new Function(stack, "MyLambda", {
  bundle: {
    installCommands: [
      "pip install --index-url https://domain.com/pypi/myprivatemodule/simple/ --extra-index-url https://pypi.org/simple -r requirements.txt ."
    ],
  },
  srcPath: "src",
  handler: "index.main",
  runtime: "python3.7",
});
```

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

### Telemetry Event Example

Source: https://v2.sst.dev/anonymous-telemetry

An example of the structure of an anonymous telemetry event that is collected.

```json
{
  "name": "CLI_COMMAND",
  "properties": {
    "command": "start"
  }
}

```

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

### Example: Bind for running tests

Source: https://v2.sst.dev/packages/sst

Use `sst bind` to run tests by binding all resources in your app if no frontend framework or container service is detected in the current directory.

```bash
npx sst bind vitest run
```

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

### Create a new Vite React app with npm

Source: https://v2.sst.dev/start/standalone

Initializes a new Vite React project in the 'packages/' directory using npm.

```bash
npm create vite@latest  

```

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

### Configure CI/CD for Production and Preview Deployments

Source: https://v2.sst.dev/learn/deploy-to-prod

These commands outline the setup for CI/CD pipelines. Deploy to production on a 'master' branch push, create preview environments for pull requests, and remove them when closed.

```bash
sst deploy --stage prod
```

```bash
sst deploy --stage <pr>
```

```bash
sst remove --stage <pr>
```

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

### Java Handler Example

Source: https://v2.sst.dev/constructs/Function

Example of a Java handler function implementing the RequestHandler interface.

```java
package example  

public class Handler implements RequestHandler<Map<String,String>, String>{

  @Override  
  public Map<String, Object> handleRequest(Map<String, String> input, Context context) {  
  }
}
```

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

### Build application with `sst build`

Source: https://v2.sst.dev/packages/sst

Build your application, synthesize stacks, and prepare assets for functions and sites. The output is placed in the `.sst/dist/` directory by default.

```bash
npx sst build [options]
```

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

### Initialize SST in Astro Project with pnpm

Source: https://v2.sst.dev/start/astro

Navigate to your Astro project directory and initialize SST using pnpm.

```bash
cd astro-project  
pnpm create sst@two  
```

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

### Create a new SST app with pnpm

Source: https://v2.sst.dev/start/standalone

Use this command to initialize a new SST project using pnpm.

```bash
pnpm create sst@two my-sst-app  

```

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

### Install global-agent

Source: https://v2.sst.dev/advanced/connecting-via-proxy

Install the global-agent package as a dev dependency in your package.json. This is required for proxy configuration.

```bash
npm install --save-dev global-agent  

```

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

### F#(.NET) Handler Example

Source: https://v2.sst.dev/constructs/Function

Example of an F# handler function within a namespace and module.

```fsharp
namespace Example  

module Hello =  

  let Handler(request:APIGatewayHttpApiV2ProxyRequest) =  
     //function logic  
```

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

### C#(.NET) Handler Example

Source: https://v2.sst.dev/constructs/Function

Example of a C# handler function within a namespace and class.

```csharp
namespace Example  
{
  public class Hello  
  {
    public Stream MyHandler(Stream stream)  
    {
       //function logic  
    }
  }
}
```

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

### Directory Structure with Sharp Layer

Source: https://v2.sst.dev/constructs/AstroSite

Example directory structure for a project using a full Sharp Lambda layer.

```bash
my-sst-app
├─ sst.config.ts
├─ astro.config.mjs
├─ src
├─ layers
│  └─ sharp
│     └─ nodejs
│        └─ node_modules
│           └─ sharp

```

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

### Install AWS SDK Packages

Source: https://v2.sst.dev/databases

Installs the necessary AWS SDK v3 packages for DynamoDB operations.

```bash
npm install @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb  

```

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

### Python Install Commands

Source: https://v2.sst.dev/constructs/v0/Function

Override default Python dependency installation behavior by providing a list of commands.

```bash
[  
  'export VARNAME="my value"',
  'pip install --index-url https://domain.com/pypi/myprivatemodule/simple/ --extra-index-url https://pypi.org/simple',
]
```

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

### Install Lambda@Edge Dependency

Source: https://v2.sst.dev/constructs/v0/NextjsSite

Install the necessary package for the NextjsSite construct to function with your Next.js application.

```bash
npm install --save @sls-next/lambda-at-edge
```

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

### Bind Resources for Testing with `sst bind`

Source: https://v2.sst.dev/resource-binding

Demonstrates how to use the `sst bind` CLI to bind resources to your tests, allowing the `sst/node` helper library to function correctly.

```bash
sst bind vitest run  
```

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

### Bind Vite with SST using npm

Source: https://v2.sst.dev/start/standalone

Starts the Vite development server and binds it with SST using npm.

```bash
npx sst bind vite  

```

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

### Initialize SST in a Remix project with npm

Source: https://v2.sst.dev/start/remix

Navigate to your Remix app directory and run this command to initialize SST using npm.

```bash
cd my-remix-app  
npx create-sst@two  
```

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

### Create SST App with Next.js

Source: https://v2.sst.dev/queues

Initialize a new SST project with a Next.js frontend using the standard template. This command sets up the basic project structure for development.

```bash
npx create-sst@two --template standard/nextjs
```

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

### Create a new Remix app with pnpm

Source: https://v2.sst.dev/start/remix

Use this command to initialize a new Remix application using pnpm.

```bash
pnpm create remix  
```

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

### Configuring CORS (GET Method Only)

Source: https://v2.sst.dev/constructs/v0/ApiGatewayV1Api

Override the default CORS behavior to allow only the GET method by configuring `defaultCorsPreflightOptions`.

```typescript
new ApiGatewayV1Api(this, "Api", {  
  restApi: {  
    defaultCorsPreflightOptions: {  
      allowOrigins: ['"*"'],  
    },  
  },  
  routes: {  
    "GET /notes": "src/list.main",  
  },  
});  

```

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

### API Route Handler Example

Source: https://v2.sst.dev/what-is-sst

Example of a Lambda function handler for an API route. It returns an HTTP response.

```typescript
export async function main() {
  return {
    statusCode: 200,
    body: JSON.stringify([
      /** list of notes **/
    ]),
  };
}

```

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

### Create SolidStart App (pnpm)

Source: https://v2.sst.dev/start/solid

Use this command to create a new SolidStart application using pnpm.

```bash
pnpm create solid  
```

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

### Get Topic Name - SST Node

Source: https://v2.sst.dev/clients/topic

Access the `topicName` property of a `Topic` construct to get the name of the SNS topic.

```javascript
console.log(Topic.myTopic.topicName);
```

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

### Create New SST Project

Source: https://v2.sst.dev/

Use this command to create a new SST project. It's a good starting point for new users.

```bash
> npm create sst@two
```

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

### Create a new Vite React app with yarn

Source: https://v2.sst.dev/start/standalone

Initializes a new Vite React project in the 'packages/' directory using yarn.

```bash
yarn create vite  

```

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

### Create a new Vite React app with pnpm

Source: https://v2.sst.dev/start/standalone

Initializes a new Vite React project in the 'packages/' directory using pnpm.

```bash
pnpm create vite  

```

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

### Start local dev environment with yarn

Source: https://v2.sst.dev/start/remix

Run this command to start the local development environment for your SST project using yarn.

```bash
yarn sst dev  
```

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

### Deploy a static site with custom build settings

Source: https://v2.sst.dev/what-is-sst

Use `StaticSite` for any static site builder. Specify the build command, output directory, and optionally a custom domain.

```typescript
new StaticSite(stack, "site", {
  path: "web",
  buildOutput: "dist",
  buildCommand: "npm run build",
  customDomain: "my-static-site.com",
});

```

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

### Create a Plain HTML Site

Source: https://v2.sst.dev/constructs/StaticSite

Deploys a plain HTML website from the specified path. This is the simplest configuration.

```typescript
import { StaticSite } from "@serverless-stack/resources";

new StaticSite(stack, "frontend", {
  path: "path/to/site",
});
```

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

### Create SST + Next.js App

Source: https://v2.sst.dev/apis

Use this command to start a new SST project with a Next.js frontend.

```bash
npx create-sst@two --template standard/nextjs  

```

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

### Configure Node.js Install Dependencies

Source: https://v2.sst.dev/constructs/Job

Specifies packages to be excluded from the bundle and installed into node_modules instead. Useful for dependencies with binary requirements.

```typescript
nodejs: {
  install: ["pg"]
}
```

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

### GET /notes/{id}

Source: https://v2.sst.dev/constructs/v1/Api

Defines a route that handles GET requests for a specific note ID and forwards the request to a specified URL.

```APIDOC
## GET /notes/{id}

### Description
Handles GET requests for a specific note ID and forwards the request to an external URL.

### Method
GET

### Endpoint
/notes/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the note to retrieve.

### Request Example
```json
{
  "example": "Not applicable for this type of route configuration"
}
```

### Response
#### Success Response (200)
- **Details**: The response from the forwarded URL.

### Response Example
```json
{
  "example": "Response from https://example.com/notes/{id}"
}
```
```

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

### Configure Externally Hosted Domain with Certificate

Source: https://v2.sst.dev/constructs/SolidStartSite

Set up a SolidStart site with an externally hosted domain, requiring an existing, validated certificate (in us-east-1) and manual CNAME record creation.

```typescript
import { Certificate } from "aws-cdk-lib/aws-certificatemanager";

new SolidStartSite(stack, "Site", {
  path: "my-solid-app/",
  customDomain: {
    isExternalDomain: true,
    domainName: "my-app.com",
    cdk: {
      certificate: Certificate.fromCertificateArn(stack, "MyCert", certArn),
    },
  },
});
```

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

### Create SolidStart App (yarn)

Source: https://v2.sst.dev/start/solid

Use this command to create a new SolidStart application using yarn.

```bash
yarn create solid  
```

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

### Function Timeout Example

Source: https://v2.sst.dev/constructs/v1/Duration

Use the Duration construct to set the timeout for a Lambda function. This example sets the timeout to 20 seconds.

```typescript
new Function(this, "MyFunction", {  
  handler: "src/lambda.main",  
  timeout: "20 seconds",  
});  

```

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

### Create a new SST app with yarn

Source: https://v2.sst.dev/start/standalone

Use this command to initialize a new SST project using yarn.

```bash
yarn create sst@two my-sst-app  

```
Tokens:
Raw