Skip to main content

User Guide: Production-Ready Serverless Backend Application Stack (Node.js)

This user guide provides documentation for utilizing the AMI product sold on AWS Marketplace.

The AMI product includes a complete set of reference implementation source code based on recommended configurations for developing AWS Lambda applications with Node.js runtime. In this document, we collectively refer to the AMI product, reference implementation source code, and user guide documentation as the "catalog."

Those who purchase the AMI can verify operations by directly executing the catalog contents or use it as a template for projects aimed at production release. You don't need to accept all contents of this catalog; you can selectively use only the parts that are necessary for your needs.

The AMI has Node.js runtime environment and recommended tools pre-installed, and when necessary, you can deploy a demo environment using the AWS CloudFormation templates prepared within the AMI.

The "Remote EC2 Sandbox" is also available, which includes only the runtime environment and recommended tools necessary for development without the application stack. Please consider using it.

If you need support based on the contents of this catalog, such as the following, please consider using Serverless Operations Catalog Support:

  • More detailed explanations and skill transfer regarding the contents of this catalog or serverless application development in general
  • Introduction of this catalog's technical stack and project configuration to field operations, onboarding support
  • Design and promotion of workflows for production release decision flows, tuning, DB configuration and performance optimization, and application monitoring
  • Resolution of other timely issues and continuous Q&A support

How to Proceed After AMI Purchase​

After purchasing this catalog product, first launch an EC2 instance, connect to it, and verify the contents. This catalog is built by inheriting Remote EC2 Sandbox, so it is premised on connecting to EC2 remotely using the same method.

  • For details about "Remote EC2 Sandbox," please refer to the Remote EC2 Sandbox User Guide.
    • However, the pricing structure of this catalog AMI product differs from Remote EC2 Sandbox, being a one-time purchase within the contract period (payment only at the time of purchase) rather than pay-as-you-go.
  • For details on how to create instances, please refer to How to Create Instances.
  • For details on how to connect to EC2 instances, please refer to Connection Methods and Usage.

Catalog Contents​

You can review the contents in the order of the following sections.

1. Configuration and Overview​

This document explains the basic configuration of this catalog.

Please refer to here for details.

2. WebAPI Implementation Guide​

This document contains practices for implementing WebAPI based on this catalog's configuration.

Please refer to here for details.

3. Event Processing Implementation Guide​

This document contains implementation practices for event processing Lambda based on this catalog's configuration.

Please refer to here for details.

This section introduces recommended implementation patterns for running on AWS Lambda, regardless of application type, such as how to use AWS SDK and Logger usage methods.

Please refer to here for details.

5. Local Debugging and Testing​

This document describes methods for running and debugging application code in a local development environment and testing methods.

Please refer to here for details.

6. AWS Lambda (Node.js) Packaging Methods​

This document explains how to create deployment packages for deploying to AWS Lambda.

Please refer to here for details.

7. Deployment and Operation Verification Using AWS CloudFormation​

This document describes how to deploy this catalog's sample code using AWS CloudFormation and verify operations.

Please refer to here for details.

8. Monitoring​

This document describes application monitoring methods based on this catalog's configuration.

Please refer to here for details.