twosdai / sbt-aws

SaaS Builder Toolkit for AWS is a developer toolkit to implement SaaS best practices and increase developer velocity.

SaaS Builder Toolkit for AWS

The SaaS Builder Toolkit for AWS (SBT) is an open-source developer toolkit to implement SaaS best practices and increase developer velocity.

It offers a high-level object-oriented abstraction to define SaaS resources on AWS imperatively using the power of modern programming languages. Using SBT’s library of infrastructure constructs, you can easily encapsulate SaaS best practices in your SaaS application, and share it without worrying about boilerplate logic.

Currently, SBT is available in the following language:

• JavaScript, TypeScript (Node.js ≥ 14.15.0)
  • We recommend using a version in Active LTS

Third-party Language Deprecation: language version is only supported until its EOL (End Of Life) shared by the vendor or community and is subject to change with prior notice.

Jump To: Developer Guide | API Reference | Getting Started | Getting Help | Contributing | Roadmap | More Resources

---

SBT is built on top of the AWS Cloud Development Kit (CDK). It offers a number of higher-order constructs (L2, L2.5 and L3) to short-circuit the time required to build SaaS applications. Specifically, SBT attempts to codify several control plane and application plane concepts into reusable components, promoting reuse and reducing boilerplate code.

Getting Started

For a detailed walkthrough, see the tutorial in the developer guide.

At a glance

Initialize a CDK project:

mkdir hello-cdk
cd hello-cdk
cdk init sample-app --language=typescript

This creates a sample project looking like this:

export class HelloCdkStack extends cdk.Stack {
  constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const queue = new sqs.Queue(this, 'HelloCdkQueue', {
      visibilityTimeout: cdk.Duration.seconds(300)
    });

    const topic = new sns.Topic(this, 'HelloCdkTopic');

    topic.addSubscription(new subs.SqsSubscription(queue));
  }
}

Install or update SBT from npm (requires Node.js ≥ 14.15.0). We recommend using a version in Active LTS

npm install @cdklabs/sbt-aws

Add a sample control plane to your application. In the HelloCdkStack add the following:

const cp = new sbt.ControlPlane(this, 'control-plane', {
  idpName: 'COGNITO',
  systemAdminRoleName: 'SystemAdmin',
  systemAdminEmail: '[email protected]',
  applicationPlaneEventSource: 'sbt-application-plane-api',
  provisioningDetailType: 'Onboarding',
  controlPlaneEventSource: 'sbt-control-plane-api',
  onboardingDetailType: 'Onboarding',
  offboardingDetailType: 'Offboarding',
});

Deploy this to your account:

cdk deploy

Getting Help

The best way to interact with our team is through GitHub. You can open an issue and choose from one of our templates for bug reports, feature requests, documentation issues, or guidance.

You may also find help on these community resources:

• Look through the API Reference or Developer Guide

Roadmap

The SBT for AWS Roadmap project board lets developers know about our upcoming features and priorities to help them plan how to best leverage the CDK and identify opportunities to contribute to the project.

Contributing

We welcome community contributions and pull requests. See CONTRIBUTING.md for information on how to set up a development environment and submit code.

More Resources

• SaaS on AWS
• Examples
• Changelog
• NOTICE
• License