Api

The Api construct is a higher level CDK construct that makes it easy to create an API. It provides a simple way to define the routes in your API. And allows you to configure the specific Lambda functions if necessary. It also allows you to configure authorization and custom domains. See the examples for more details.

Unlike the lower level Function construct, the Api construct doesn't directly extend a CDK construct, it wraps around a couple of them.

Initializer#

new Api(scope: Construct, id: string, props: ApiProps)

Parameters

scope Construct
id string
props ApiProps

Examples#

The Api construct is designed to make it easy to get started it with, while allowing for a way to fully configure it as well. Let's look at how, through a couple of examples.

Using the minimal config#

import { Api } from "@serverless-stack/resources";

new Api(this, "Api", {
  routes: {
    "GET    /notes": "src/list.main",
    "POST   /notes": "src/create.main",
    "GET    /notes/{id}": "src/get.main",
    "PUT    /notes/{id}": "src/update.main",
    "DELETE /notes/{id}": "src/delete.main",
  },
});

Note that, the route key can have extra spaces in between, they are just ignored.

Adding routes#

Add routes after the API has been created.

const api = new Api(this, "Api", {
  routes: {
    "GET    /notes": "src/list.main",
    "POST   /notes": "src/create.main",
  },
});

api.addRoutes(this, {
  "GET    /notes/{id}": "src/get.main",
  "PUT    /notes/{id}": "src/update.main",
  "DELETE /notes/{id}": "src/delete.main",
});

Lazily adding routes#

Create an empty Api construct and lazily add the routes.

const api = new Api(this, "Api");

api.addRoutes(this, {
  "GET    /notes": "src/list.main",
  "POST   /notes": "src/create.main",
});

Specifying function props for all the routes#

You can extend the minimal config, to set some function props and have them apply to all the routes.

new Api(this, "Api", {
  defaultFunctionProps: {
    timeout: 20,
    environment: { tableName: table.tableName },
    permissions: [table],
  },
  routes: {
    "GET  /notes": "src/list.main",
    "POST /notes": "src/create.main",
  },
});

Using the full config#

If you wanted to configure each Lambda function separately, you can pass in the ApiRouteProps.

new Api(this, "Api", {
  routes: {
    "GET /notes": {
      function: {
        srcPath: "src/",
        handler: "list.main",
        environment: { tableName: table.tableName },
        permissions: [table],
      },
    },
  },
});

Note that, you can set the defaultFunctionProps while using the function per route. The function will just override the defaultFunctionProps. Except for the environment, the layers, and the permissions properties, that will be merged.

new Api(this, "Api", {
  defaultFunctionProps: {
    timeout: 20,
    environment: { tableName: table.tableName },
    permissions: [table],
  },
  routes: {
    "GET /notes": {
      function: {
        handler: "list.main",
        timeout: 10,
        environment: { bucketName: bucket.bucketName },
        permissions: [bucket],
      },
    },
    "POST /notes": "create.main",
  },
});

So in the above example, the GET /notes function doesn't use the timeout that is set in the defaultFunctionProps. It'll instead use the one that is defined in the function definition (10 seconds). And the function will have both the tableName and the bucketName environment variables set; as well as permissions to both the table and the bucket.

Configuring the Http Api#

Configure the internally created CDK Api instance.

new Api(this, "Api", {
  httpApi: {
    disableExecuteApiEndpoint: true,
  },
  routes: {
    "GET /notes": "src/list.main",
  },
});

Importing an existing Http Api#

Override the internally created CDK HttpApi instance.

import { HttpApi } from "@aws-cdk/aws-apigatewayv2";

new Api(this, "Api", {
  httpApi: HttpApi.fromHttpApiAttributes(this, "MyHttpApi", {
    httpApiId,
  }),
  routes: {
    "GET /notes": "src/list.main",
  },
});

Configuring the access log format#

Use a CSV format instead of default JSON format.

new Api(this, "Api", {
  accessLog:
    "$context.identity.sourceIp,$context.requestTime,$context.httpMethod,$context.routeKey,$context.protocol,$context.status,$context.responseLength,$context.requestId",
  routes: {
    "GET /notes": "src/list.main",
  },
});

Configuring CORS#

Override the default behavior of allowing all methods, and only allow the GET method.

import { HttpMethod } from "@aws-cdk/aws-apigatewayv2";

new Api(this, "Api", {
  cors: {
    allowMethods: [HttpMethod.GET],
  },
  routes: {
    "GET /notes": "src/list.main",
  },
});

Configuring custom domains#

You can also configure the API with a custom domain. SST currently supports domains that are configured using Route 53. If your domains are hosted elsewhere, you can follow this guide to migrate them to Route 53.

Using the basic config#

new Api(this, "Api", {
  customDomain: "api.domain.com",
  routes: {
    "GET /notes": "src/list.main",
  },
});

Configuring with a wildcard#

new Api(this, "Api", {
  customDomain: "*.domain.com",
  routes: {
    "GET /notes": "src/list.main",
  },
});

Using the full config#

new Api(this, "Api", {
  customDomain: {
    domainName: "api.domain.com",
    hostedZone: "domain.com",
    path: "v1",
  },
  routes: {
    "GET /notes": "src/list.main",
  },
});

Mapping multiple APIs to the same domain#

const usersApi = new Api(this, "UsersApi", {
  customDomain: {
    domainName: "api.domain.com",
    path: "users",
  },
});

new Api(this, "PostsApi", {
  customDomain: {
    domainName: usersApi.apiGatewayDomain,
    path: "posts",
  },
});

Importing an existing API Gateway custom domain#

import { DomainName } from "@aws-cdk/aws-apigatewayv2";

new Api(this, "Api", {
  customDomain: {
    domainName: DomainName.fromDomainNameAttributes(this, "MyDomain", {
      name,
      regionalDomainName,
      regionalHostedZoneId,
    }),
    path: "newPath",
  },
  routes: {
    "GET /notes": "src/list.main",
  },
});

Importing an existing certificate#

import { Certificate } from "@aws-cdk/aws-certificatemanager";

new Api(this, "Api", {
  customDomain: {
    domainName: "api.domain.com",
    certificate: Certificate.fromCertificateArn(this, "MyCert", certArn),
  },
  routes: {
    "GET /notes": "src/list.main",
  },
});

Specifying a hosted zone#

If you have multiple hosted zones for a given domain, you can choose the one you want to use to configure the domain.

import { HostedZone } from "@aws-cdk/aws-route53";

new Api(this, "Api", {
  customDomain: {
    domainName: "api.domain.com",
    hostedZone: HostedZone.fromHostedZoneAttributes(this, "MyZone", {
      hostedZoneId,
      zoneName,
    }),
  },
  routes: {
    "GET /notes": "src/list.main",
  },
});

Loading domain name from SSM parameter#

If you have the domain name stored in AWS SSM Parameter Store, you can reference the value as the domain name:

import { StringParameter } from "@aws-cdk/aws-ssm";

const rootDomain = StringParameter.valueForStringParameter(this, `/myApp/domain`);

new Api(this, "Api", {
  customDomain: {
    domainName: `api.${rootDomain}`,
    hostedZone: rootDomain,
  },
  routes: {
    "GET /notes": "src/list.main",
  },
});

Note that, normally SST will look for a hosted zone by stripping out the first part of the domainName. But this is not possible when the domainName is a reference. Since its value will be resolved at deploy time. So you'll need to specify the hostedZone explicitly.

Attaching permissions#

You can attach a set of permissions to all or some of the routes.

For the entire API#

Allow the entire API to access S3.

const api = new Api(this, "Api", {
  routes: {
    "GET    /notes": "src/list.main",
    "POST   /notes": "src/create.main",
    "GET    /notes/{id}": "src/get.main",
    "PUT    /notes/{id}": "src/update.main",
    "DELETE /notes/{id}": "src/delete.main",
  },
});

api.attachPermissions(["s3"]);

For a specific route#

Allow one of the routes to access S3.

const api = new Api(this, "Api", {
  routes: {
    "GET    /notes": "src/list.main",
    "POST   /notes": "src/create.main",
    "GET    /notes/{id}": "src/get.main",
    "PUT    /notes/{id}": "src/update.main",
    "DELETE /notes/{id}": "src/delete.main",
  },
});

api.attachPermissionsToRoute("GET /notes", ["s3"]);

Adding auth#

You can use IAM, JWT, or a Lambda authorizer to add auth to your APIs.

Adding IAM authorization#

You can secure your APIs (and other AWS resources) by setting the defaultAuthorizationType to AWS_IAM and using the Auth construct.

new Api(this, "Api", {
  defaultAuthorizationType: ApiAuthorizationType.AWS_IAM,
  routes: {
    "GET  /notes": "list.main",
    "POST /notes": "create.main",
  },
});

Adding IAM authorization to a specific route#

You can also secure specific routes in your APIs by setting the authorizationType to AWS_IAM and using the Auth construct.

new Api(this, "Api", {
  routes: {
    "GET /public": "src/public.main",
    "GET /private": {
      authorizationType: ApiAuthorizationType.AWS_IAM,
      function: "src/private.main",
    },
  },
});

Adding JWT authorization#

JWT allows authorized users to access your API. Note that, this is a different authorization method when compared to using AWS_IAM and the Auth construct, which allows you to secure other AWS resources as well.

import { HttpJwtAuthorizer } from "@aws-cdk/aws-apigatewayv2-authorizers";

new Api(this, "Api", {
  defaultAuthorizationType: ApiAuthorizationType.JWT,
  defaultAuthorizer: new HttpJwtAuthorizer({
    jwtAudience: ["UsGRQJJz5sDfPQDs6bhQ9Oc3hNISuVif"],
    jwtIssuer: "https://myorg.us.auth0.com",
  }),
  routes: {
    "GET /notes": "src/list.main",
  },
});

Adding JWT authorization to a specific route#

You can also secure specific routes using JWT by setting the authorizationType per route.

import { HttpJwtAuthorizer } from "@aws-cdk/aws-apigatewayv2-authorizers";

new Api(this, "Api", {
  defaultAuthorizer: new HttpJwtAuthorizer({
    jwtAudience: ["UsGRQJJz5sDfPQDs6bhQ9Oc3hNISuVif"],
    jwtIssuer: "https://myorg.us.auth0.com",
  }),
  routes: {
    "GET /public": "src/public.main",
    "GET /private": {
      function: {
        handler: "src/private.main",
        authorizationType: ApiAuthorizationType.JWT,
      },
    },
  },
});

Using Cognito User Pool as the JWT authorizer#

JWT can also use a Cognito User Pool as an authorizer.

import { HttpUserPoolAuthorizer } from "@aws-cdk/aws-apigatewayv2-authorizers";

new Api(this, "Api", {
  defaultAuthorizationType: ApiAuthorizationType.JWT,
  defaultAuthorizer: new HttpUserPoolAuthorizer({
    userPool,
    userPoolClient,
  }),
  defaultAuthorizationScopes: ["user.id", "user.email"],
  routes: {
    "GET /notes": "src/list.main",
  },
});

Adding Lambda authorization#

You can also use a Lambda function to authorize users to access your API. Like JWT and AWS_IAM, the Lambda authorizer is another way to secure your API.

import { HttpLambdaAuthorizer } from "@aws-cdk/aws-apigatewayv2-authorizers";

new Api(this, "Api", {
  defaultAuthorizationType: ApiAuthorizationType.CUSTOM,
  defaultAuthorizer: new HttpLambdaAuthorizer({
    authorizerName: "LambdaAuthorizer",
    handler: new sst.Function(this, "Authorizer", {
      handler: "src/authorizer.main",
    }),
  }),
  routes: {
    "GET /notes": "src/list.main",
  },
});

Adding Lambda authorization to a specific route#

You can also secure specific routes using a Lambda authorizer by setting the authorizationType per route.

import { HttpLambdaAuthorizer } from "@aws-cdk/aws-apigatewayv2-authorizers";

new Api(this, "Api", {
  defaultAuthorizer: new HttpLambdaAuthorizer({
    authorizerName: "LambdaAuthorizer",
    handler: new sst.Function(this, "Authorizer", {
      handler: "src/authorizer.main",
    }),
  }),
  routes: {
    "GET /public": "src/public.main",
    "GET /private": {
      function: {
        handler: "src/private.main",
        authorizationType: ApiAuthorizationType.CUSTOM,
      },
    },
  },
});

Getting the function for a route#

const api = new Api(this, "Api", {
  routes: {
    "GET    /notes": "src/list.main",
    "POST   /notes": "src/create.main",
    "GET    /notes/{id}": "src/get.main",
    "PUT    /notes/{id}": "src/update.main",
    "DELETE /notes/{id}": "src/delete.main",
  },
});

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

Properties#

An instance of Api contains the following properties.

url#

Type: string

The URL of the Api.

httpApi#

Type: cdk.aws-apigatewayv2.HttpApi

The internally created CDK HttpApi instance.

accessLogGroup?#

Type: cdk.aws-logs.LogGroup

If access logs are enabled, this is the internally created CDK LogGroup instance.

customDomainUrl?#

Type: string

If custom domain is enabled, this is the custom domain URL of the Api.

apiGatewayDomain?#

Type: cdk.aws-apigatewayv2.DomainName

If custom domain is enabled, this is the internally created CDK DomainName instance.

acmCertificate?#

Type: cdk.aws-certificatemanager.Certificate

If custom domain is enabled, this is the internally created CDK Certificate instance.

Methods#

An instance of Api contains the following methods.

getFunction#

getFunction(routeKey: string): Function

Parameters

routeKey string

Returns

Function

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, GET /notes.

addRoutes#

addRoutes(scope: cdk.Construct, routes: { [key: string]: FunctionDefinition | ApiRouteProps })

Parameters

scope cdk.Construct
routes { [key: string]: FunctionDefinition | ApiRouteProps }

An associative array with the key being the route as a string and the value is either a FunctionDefinition or the ApiRouteProps.

attachPermissions#

attachPermissions(permissions: Permissions)

Parameters

permissions Permissions

Attaches the given list of permissions to all the routes. This allows the functions to access other AWS resources.

Internally calls Function.attachPermissions.

attachPermissionsToRoute#

attachPermissionsToRoute(routeKey: string, permissions: Permissions)

Parameters

routeKey string
permissions Permissions

Attaches the given list of permissions to a specific route. This allows that function to access other AWS resources.

Internally calls Function.attachPermissions.

ApiProps#

routes?#

Type : { [key: string]: FunctionDefinition | ApiRouteProps }, defaults to {}

The routes for this API. Takes an associative array, with the key being the route as a string and the value is either a FunctionDefinition.

{
  "GET /notes": "src/list.main",
  "GET /notes/{id}": "src/get.main",
}

Or the ApiRouteProps.

{
  "GET /notes": {
    authorizationType: ApiAuthorizationType.AWS_IAM,
    function: {
      handler: "src/list.main",
      environment: {
        TABLE_NAME: "notesTable",
      },
    }
  },
}

cors?#

Type : boolean | cdk.aws-apigatewayv2.CorsPreflightOptions, defaults to true

CORS support for all the endpoints in the API. Takes a boolean value or a cdk.aws-apigatewayv2.CorsPreflightOptions.

accessLog?#

Type : boolean | string | cdk.aws-apigatewayv2.CfnApiGatewayManagedOverrides.AccessLogSettingsProperty, defaults to true

CloudWatch access logs for the API. Takes a boolean value, a string with log format, or a cdk.aws-apigatewayv2.CfnApiGatewayManagedOverrides.AccessLogSettingsProperty.

customDomain?#

Type : string | ApiCustomDomainProps

The customDomain for this API. SST currently supports domains that are configured using Route 53. If your domains are hosted elsewhere, you can follow this guide to migrate them to Route 53.

Takes either the domain as a string.

"api.domain.com"

Or the ApiCustomDomainProps.

{
  domainName: "api.domain.com",
  hostedZone: "domain.com",
  path: "v1",
}

httpApi?#

Type : cdk.aws-apigatewayv2.HttpApiProps | cdk.aws-apigatewayv2.HttpApi

Pass in a cdk.aws-apigatewayv2.HttpApi value to override the default settings this construct uses to create the CDK HttpApi internally.

Or, pass in an instance of the CDK cdk.aws-apigatewayv2.HttpApi. SST will use the provided CDK HttpApi instead of creating one internally.

defaultFunctionProps?#

Type : FunctionProps, defaults to {}

The default function props to be applied to all the Lambda functions in the API. If the function is specified for a route, these default values are overridden. Except for the environment, the layers, and the permissions properties, that will be merged.

defaultAuthorizationType?#

Type : ApiAuthorizationType, defaults to ApiAuthorizationType.NONE

The authorization type for all the endpoints in the API. Set using ApiAuthorizationType. Supports AWS IAM, JWT, and a custom Lambda authorizer. Defaults to no authorization, ApiAuthorizationType.NONE.

While IAM, JWT, and Lambda authorizers all allows you to secure your APIs. The IAM method together with the Auth construct uses the Cognito Identity Pool. This allows you to secure other AWS resources as well.

On the other hand, the JWT and the Lambda authorizers are for securing APIs specifically.

If you are just starting out, we recommend using the IAM method.

defaultAuthorizer?#

Type : cdk.aws-apigatewayv2-authorizers.HttpJwtAuthorizer | cdk.aws-apigatewayv2-authorizers.HttpUserPoolAuthorizer | cdk.aws-apigatewayv2-authorizers.HttpLambdaAuthorizer

The JWT authorizer for all the routes in the API. Currently, supports cdk.aws-apigatewayv2-authorizers.HttpJwtAuthorizer, cdk.aws-apigatewayv2-authorizers.HttpUserPoolAuthorizer, or cdk.aws-apigatewayv2-authorizers.HttpLambdaAuthorizer.

defaultAuthorizationScopes?#

Type : string[], defaults to []

An array of scopes to include in the authorization when using JWT as the defaultAuthorizationType. These will be merged with the scopes from the attached authorizer.

For example, ["user.id", "user.email"].

defaultPayloadFormatVersion?#

Type : ApiPayloadFormatVersion, defaults to ApiPayloadFormatVersion.V2

The payload format versions for all the endpoints in the API. Set using ApiPayloadFormatVersion. Supports 2.0 and 1.0. Defaults to 2.0, ApiPayloadFormatVersion.V2.

ApiRouteProps#

function#

Type : FunctionDefinition

The function definition used to create the function for this route.

authorizationType?#

Type : ApiAuthorizationType

The authorization type for a specific route. Set using ApiAuthorizationType. Defaults to defaultAuthorizationType.

authorizer?#

Type : cdk.aws-apigatewayv2-authorizers.HttpJwtAuthorizer | cdk.aws-apigatewayv2-authorizers.HttpUserPoolAuthorizer | cdk.aws-apigatewayv2-authorizers.HttpLambdaAuthorizer

The JWT or Lambda authorizer for a specific route. Defaults to defaultAuthorizer.

authorizationScopes?#

Type : string[]

An array of scopes to include in the authorization for a specific route. Defaults to defaultAuthorizationScopes. If both defaultAuthorizationScopes and authorizationScopes are configured, authorizationScopes is used. Instead of the union of both.

payloadFormatVersion?#

Type : ApiPayloadFormatVersion

The payload format versions for a specific route. Set using ApiPayloadFormatVersion. Supports 2.0 and 1.0. Defaults to defaultPayloadFormatVersion.

ApiCustomDomainProps#

domainName#

Type : string | cdk.aws-apigatewayv2.DomainName

The domain to be assigned to the API endpoint. Takes the custom domain as a string (ie. api.domain.com) or a cdk.aws-apigatewayv2.DomainName.

Currently supports domains that are configured using Route 53.

hostedZone?#

Type : string | cdk.aws-route53.HostedZone, defaults to the base domain

The hosted zone in Route 53 that contains the domain. Takes the name of the hosted zone as a string or the hosted zone construct cdk.aws-route53.HostedZone. By default, SST will look for a hosted zone by stripping out the first part of the domainName that's passed in. So, if your domainName is api.domain.com. SST will default the hostedZone to domain.com.

Set this option if SST cannot find the hosted zone in Route 53.

certificate?#

Type : cdk.aws-certificatemanager.Certificate, defaults to undefined

The certificate for the domain. By default, SST will create a certificate with the domain name from the domainName option.

Set this option if you have an existing certificate in AWS Certificate Manager you want to use.

path?#

Type : string, defaults to undefined

The base mapping for the custom domain. For example, by setting the domainName to api.domain.com and path to v1, the custom domain URL for the API will become https://api.domain.com/v1. If the path is not set, the custom domain URL will be https://api.domain.com.

caution

You cannot change the path once it has been set.

Note, if the path was not defined initially, it cannot be defined later. If the path was initially defined, it cannot be later changed to undefined. Instead, you'd need to remove the customDomain option from the construct, deploy it. And then set it to the new path value.

ApiAuthorizationType#

An enum with the following members representing the authorization types.

Member	Description
AWS_IAM	Used along with the `Auth` construct to add Cognito Identity Pool and IAM authorization.
CUSTOM	Using a custom Lambda function as an authorizer.
JWT	Using JWT as an authorizer.
NONE	No authorization type is set.

For example, to use IAM, set ApiAuthorizationType.AWS_IAM.

ApiPayloadFormatVersion#

An enum with the following members representing the payload format versions.

Member	Description
V2	Version 2.0 of the payload is sent to the lambda handler.
V1	Version 1.0 of the payload is sent to the lambda handler.

For example, to use V2, set ApiPayloadFormatVersion.V2.