ApiGatewayV2

Reference doc for the `sst.aws.ApiGatewayV2` component.

The ApiGatewayV2 component lets you add an Amazon API Gateway HTTP API to your app.

Create the API

const api = new sst.aws.ApiGatewayV2("MyApi");

Add a custom domain

new sst.aws.ApiGatewayV2("MyApi", {
  domain: "api.example.com"
});

Add routes

api.route("GET /", "src/get.handler");
api.route("POST /", "src/post.handler");

Configure the routes

You can configure the route and its handler function.

api.route("GET /", "src/get.handler", { auth: { iam: true } });
api.route("POST /", { handler: "src/post.handler", memory: "2048 MB" });

Set defaults for all routes

You can use the transform to set some defaults for all your routes. For example, instead of setting the memory for each route.

api.route("GET /", { handler: "src/get.handler", memory: "2048 MB" });
api.route("POST /", { handler: "src/post.handler", memory: "2048 MB" });

You can set it through the transform.

new sst.aws.ApiGatewayV2("MyApi", {
  transform: {
    route: {
      handler: {
        memory: "2048 MB"
      }
    }
  }
});

api.route("GET /", "src/get.handler");
api.route("POST /", "src/post.handler");

Constructor

new ApiGatewayV2(name, args?, opts?)

Parameters

name string
args? ApiGatewayV2Args
opts? ComponentResourceOptions

ApiGatewayV2Args

accessLog?

Type Input<Object>

retention?

Default {retention: “forever”}

Configure the API Gateway logs in CloudWatch. By default, access logs are enabled and kept forever.

{
  accessLog: {
    retention: "1 week"
  }
}

accessLog.retention?

Default forever

The duration the API Gateway logs are kept in CloudWatch.

domain?

Type Input<string | Object>

cert?
dns?
name
path?

Set a custom domain for your HTTP API.

Automatically manages domains hosted on AWS Route 53, Cloudflare, and Vercel. For other providers, you’ll need to pass in a cert that validates domain ownership and add the DNS records.

By default this assumes the domain is hosted on Route 53.

{
  domain: "example.com"
}

For domains hosted on Cloudflare.

{
  domain: {
    name: "example.com",
    dns: sst.cloudflare.dns()
  }
}

domain.cert?

Type Input<string>

The ARN of an ACM (AWS Certificate Manager) certificate that proves ownership of the domain. By default, a certificate is created and validated automatically.

To manually set up a domain on an unsupported provider, you’ll need to:

Validate that you own the domain by creating an ACM certificate. You can either validate it by setting a DNS record or by verifying an email sent to the domain owner.
Once validated, set the certificate ARN as the cert and set dns to false.
Add the DNS records in your provider to point to the API Gateway URL.

{
  domain: {
    name: "example.com",
    dns: false,
    cert: "arn:aws:acm:us-east-1:112233445566:certificate/3a958790-8878-4cdc-a396-06d95064cf63"
  }
}

domain.dns?

Type Input<false | sst.aws.dns | sst.cloudflare.dns | sst.vercel.dns>

Default sst.aws.dns

The DNS provider to use for the domain. Defaults to the AWS.

Takes an adapter that can create the DNS records on the provider. This can automate validating the domain and setting up the DNS routing.

Supports Route 53, Cloudflare, and Vercel adapters. For other providers, you’ll need to set dns to false and pass in a certificate validating ownership via cert.

Specify the hosted zone ID for the Route 53 domain.

{
  domain: {
    name: "example.com",
    dns: sst.aws.dns({
      zone: "Z2FDTNDATAQYW2"
    })
  }
}

Use a domain hosted on Cloudflare, needs the Cloudflare provider.

{
  domain: {
    name: "example.com",
    dns: sst.cloudflare.dns()
  }
}

Use a domain hosted on Vercel, needs the Vercel provider.

{
  domain: {
    name: "example.com",
    dns: sst.vercel.dns()
  }
}

domain.name

Type Input<string>

The custom domain you want to use.

{
  domain: {
    name: "example.com"
  }
}

Can also include subdomains based on the current stage.

{
  domain: {
    name: `${$app.stage}.example.com`
  }
}

domain.path?

Type Input<string>

The base mapping for the custom domain. This adds a suffix to the URL of the API.

Given the following base path and domain name.

{
  domain: {
    name: "api.example.com",
    path: "v1"
  }
}

The full URL of the API will be https://api.example.com/v1/.

Be default there is no base path, so if the name is api.example.com, the full URL will be https://api.example.com.

transform?

Type Object

accessLog?
api?
domainName?
route? Object
- args?
- handler?
stage?

Transform how this component creates its underlying resources.

transform.accessLog?

Type LogGroupArgs | (args: LogGroupArgs => void)

Transform the CloudWatch LogGroup resource used for access logs.

transform.api?

Type ApiArgs | (args: ApiArgs => void)

Transform the API Gateway HTTP API resource.

transform.domainName?

Type DomainNameArgs | (args: DomainNameArgs => void)

Transform the API Gateway HTTP API domain name resource.

transform.route?

Type Object

Transform the routes. This is called for every route that is added.

You can use this to set any common props for all the routes and their handler function. Like the other transforms, you can either pass in an object or a callback.

Here we are ensuring that all handler functions of our routes have a memory of 2048 MB.

{
  transform: {
    route: {
      handler: {
        memory: "2048 MB"
      },
    }
  }
}

Enable IAM auth for all our routes.

{
  transform: {
    route: {
      args: (props) => {
        props.auth = { iam: true };
      }
    }
  }
}

transform.route.args?

Type ApiGatewayV2RouteArgs | (args: ApiGatewayV2RouteArgs => void)

Transform the arguments for the route.

transform.route.handler?

Type FunctionArgs | (args: FunctionArgs => void)

Transform the handler function of the route.

transform.stage?

Type StageArgs | (args: StageArgs => void)

Transform the API Gateway HTTP API stage resource.

Properties

nodes

Type Object

api
logGroup

The underlying resources this component creates.

nodes.api

Type Api

The Amazon API Gateway HTTP API

nodes.logGroup

Type LogGroup

The CloudWatch LogGroup for the access logs.

url

Type Output<string>

The URL of the API.

If the domain is set, this is the URL with the custom domain. Otherwise, it’s the autogenerated API Gateway URL.

SDK

The following are accessible through the SDK at runtime.

url

Type string

The URL of the API.

If the domain is set, this is the URL with the custom domain. Otherwise, it’s the autogenerated API Gateway URL.

Methods

route

route(route, handler, args?)

Parameters

route string
The path for the route.
handler string | FunctionArgs
The function that’ll be invoked.
args? ApiGatewayV2RouteArgs
Configure the route.

Returns ApiGatewayV2LambdaRoute

Add a route to the API Gateway HTTP API. The route is a combination of

An HTTP method and a path, {METHOD} /{path}.
Or a $default route.

A method could be one of GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, or ANY. Here ANY matches any HTTP method.

The path can be a combination of

Literal segments, /notes, /notes/new, etc.
Parameter segments, /notes/{noteId}, /notes/{noteId}/attachments/{attachmentId}, etc.
Greedy segments, /{proxy+}, /notes/{proxy+}, etc. The {proxy+} segment is a greedy segment that matches all child paths. It needs to be at the end of the path.

The $default is a reserved keyword for the default route. It’ll be matched if no other route matches.

When a request comes in, the API Gateway will look for the most specific match. If no route matches, the $default route will be invoked.

Here’s how you add a simple route.

api.route("GET /", "src/get.handler");

Match any HTTP method.

api.route("ANY /", "src/route.handler");

Add a default route.

api.route("GET /", "src/get.handler")
api.route($default, "src/default.handler");

Add a parameterized route.

api.route("GET /notes/{id}", "src/get.handler");

Add a greedy route.

api.route("GET /notes/{proxy+}", "src/greedy.handler");

Enable auth for a route.

api.route("GET /", "src/get.handler")
api.route("POST /", "src/post.handler", {
  auth: {
    iam: true
  }
});

Customize the route handler.

api.route("GET /", {
  handler: "src/get.handler",
  memory: "2048 MB"
});

ApiGatewayV2RouteArgs

auth?

Type Input<Object>

iam?
jwt? Input<Object>

Enable auth for your HTTP API.

{
  auth: {
    iam: true
  }
}

auth.iam?

Type Input<true>

Enable IAM authorization for a given API route. When IAM auth is enabled, clients need to use Signature Version 4 to sign their requests with their AWS credentials.

auth.jwt?

Type Input<Object>

Enable JWT or JSON Web Token authorization for a given API route. When JWT auth is enabled, clients need to include a valid JWT in their requests.

You can configure JWT auth.

{
  auth: {
    jwt: {
      issuer: "https://issuer.com/",
      audiences: ["https://api.example.com"],
      scopes: ["read:profile", "write:profile"],
      identitySource: "$request.header.AccessToken"
    }
  }
}

You can also use Cognito as the identity provider.

{
  auth: {
    jwt: {
      audiences: [userPoolClient.id],
      issuer: $interpolate`https://cognito-idp.${aws.getArnOutput(userPool).region}.amazonaws.com/${userPool.id}`,
    }
  }
}

Where userPool and userPoolClient are:

const userPool = new aws.cognito.UserPool();
const userPoolClient = new aws.cognito.UserPoolClient();

auth.jwt.audiences

Type Input<Input<string>[]>

List of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list.

auth.jwt.identitySource?

Type Input<string>

Default “$request.header.Authorization”

Specifies where to extract the JWT from the request.

auth.jwt.issuer

Type Input<string>

Base domain of the identity provider that issues JSON Web Tokens.

auth.jwt.scopes?

Type Input<Input<string>[]>

Defines the permissions or access levels that the JWT grants. If the JWT does not have the required scope, the request is rejected. By default it does not require any scopes.

transform?

Type Object

authorizer?
integration?
route?

Transform how this component creates its underlying resources.

transform.authorizer?

Type AuthorizerArgs | (args: AuthorizerArgs => void)

Transform the API Gateway authorizer resource.

transform.integration?

Type IntegrationArgs | (args: IntegrationArgs => void)

Transform the API Gateway HTTP API integration resource.

transform.route?

Type RouteArgs | (args: RouteArgs => void)

Transform the API Gateway HTTP API route resource.