Home

1. Overview

2. Quick start

       2.1 Installing the Framework

       2.2 Usage guide

             2.2.1 Creating Project files

             2.2.2 Creating configuration files for environment

             2.2.3 Creating lambda files

             2.2.4 Adding other infrastructure components

             2.2.5 Open project in your IDE

       2.3 Deployment

             2.3.1 Create an S3 bucket for aws-syndicate artifacts

             2.3.2 Build project artifacts

             2.3.3 Deploy project resources to AWS account

             2.3.4 Update resources

             2.3.5 Lambdas invocations metrics

             2.3.6 Clean up project resources from AWS Account

             2.3.7 Observing the environment manipulation history

       2.4 Export

             2.4.1 API Gateway OpenAPI specification

       2.5 Examples

3. Lambda Requirements for Automatic Artifacts Build

       3.1 Python Lambdas

       3.2 Java Lambdas

       3.3 NodeJS Lambdas

4. Resources Meta Descriptions

       4.1 Lambda

       4.2 Dynamo DB table

       4.3 CloudWatch Event Rule

       4.4 S3 Bucket

       4.5 API Gateway

             4.5.1 API Gateway

             4.5.2 API Gateway Authorizer

             4.5.3 API Gateway Resource (path)

             4.5.4 API Gateway Resource Method

             4.5.5 Ways to deploy API Gateway to AWS Account with Syndicate

       4.6 SNS Topic

       4.7 CloudWatch Alarm

       4.8 Kinesis Stream

       4.9 IAM Policy

       4.10 IAM Role

       4.11 Step Functions Activity

       4.12 SQS

       4.13 Step Functions

       4.14 Cognito

             4.14.1 Cognito User Pools

             4.14.2 Amazon Cognito Identity Pools

       4.15 SNS Application

       4.16 Elastic Beanstalk

       4.17 EC2 Instance

       4.18 Batch Compute Environment Instance

       4.19 Batch Job Queue Instance

       4.20 Batch Job Definition Instance

       4.21 DocumentDB Cluster

       4.22 DocumentDB Instance

       4.23 Firehose

       4.24 Web-Socket API

       4.25 EventBridge

             4.25.1 EventBridge rule

             4.25.2 EventBridge Schedule

       4.26 DAX Cluster

5. Using Aliases

       5.1 Static Aliases

       5.2 Dynamic Aliases

6. Available Framework Commands

7. Basic Deployment Flow