Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/crisboarna/terraform-aws-api-gateway-lambda-dynamodb

Terraform module which deploys a serverless HTTP endpoint backed by AWS API Gateway, Lambda & DynamoDB
https://github.com/crisboarna/terraform-aws-api-gateway-lambda-dynamodb

Last synced: about 2 months ago
JSON representation

Terraform module which deploys a serverless HTTP endpoint backed by AWS API Gateway, Lambda & DynamoDB

Host: GitHub
URL: https://github.com/crisboarna/terraform-aws-api-gateway-lambda-dynamodb
Owner: crisboarna
License: mit
Created: 2018-05-15T05:52:46.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2020-05-10T16:47:40.000Z (over 4 years ago)
Last Synced: 2024-06-12T10:36:04.893Z (3 months ago)
Language: HCL
Homepage: https://registry.terraform.io/modules/crisboarna/api-gateway-lambda-dynamodb/aws/
Size: 57.6 KB
Stars: 30
Watchers: 4
Forks: 18
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Terraform AWS API Gateway Lambda DynamoDB

### Terraform module for AWS API Gateway Lambda DynamoDB infrastructure
[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
![stability-stable](https://img.shields.io/badge/stability-stable-brightgreen.svg)
![Commitizen-friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)

## Table of Contents
* [Features](#features)
* [Usage](#usage)
* [Deployment](#deployment)
* [Example](#example)

## Features
Terraform module which deploys a serverless HTTP endpoint backed by AWS API Gateway, Lambda & DynamoDB

***Attention***

Starting from version 1.15.0, this module targets Terraform 0.12+. If you are using Terraform <=v0.11 you must use up to version 1.14.0.

### API Gateway

This module is created with a single stage that is given as parameter.
The default path that is created is `/api/messages`. This can be expanded upon as the API GW ID, resources and methods are exposed.
If you do not wish to have the default values, you can specify `api_gw_disable_resource_creation = true` and you can create the paths desired.
Allows specification of Endpoint Configuration Type via variable `api_gw_endpoint_configuration_type` with `EDGE`, `REGIONAL` or `PRIVATE`. Defaults to `EDGE`

**Note**

This results in having to create the final `aws_api_gateway_deployment` as well.

### Lambda

This module is created with full customization by user.
- Can use either local filename path `lambda_file_name` or remote S3 bucket configuration.
- Supports Lambda Layers
- Supports VPC

**Must** use either the local filename or S3 option as they are mutually exclusive.
Exports S3 bucket to allow usage by multiple Lambda's but given `lambda_code_s3_bucket_use_existing=true` it will use existing S3 bucket provided in `lambda_code_s3_bucket_existing`.
- This module by default, if created allows accompanying Lambda access to `dynamodb:PutItem`, `dynamodb:DescribeTable`, `dynamodb:DeleteItem`, `dynamodb:GetItem`, `dynamodb:Scan`, `dynamodb:Query` all DynamoDB tables.

### DynamoDB

This module is optional. Lambda is created with R/W permission for DynamoDB to allow Lambda creation of tables or optionally to create them before-hand with this script.
- This module by default, if created allows accompanying Lambda access to `dynamodb:PutItem`, `dynamodb:DescribeTable`, `dynamodb:DeleteItem`, `dynamodb:GetItem`, `dynamodb:Scan`, `dynamodb:Query` all DynamoDB tables.

**NOTE**

The attributes and table properties are in separate lists due to current HCL language parser limitations. Will update to single cohesive object once situation improves.
## Usage
```hcl-terraform
module "api-gateway-lambda-dynamodb" {
source = "crisboarna/api-gateway-lambda-dynamodb/aws"
version = "1.16.0"

# insert the 10 required variables here
}
```

## Deployment
1. Run build process to generate Lambda ZIP file locally to match `lambda_zip_path` variable path
2. Provide all needed variables from `variables.tf` file or copy paste and change example below
3. Create/Select Terraform workspace before deployment
4. Run `terraform plan -var-file="<.tfvars file>` to check for any errors and see what will be built
5. Run `terraform apply -var-file="<.tfvars file>` to deploy infrastructure

**Example Deployment Script**
```sh
#!/usr/bin/env bash

if [[ ! -d .terraform ]]; then
terraform init
fi
if ! terraform workspace list 2>&1 | grep -qi "$ENVIRONMENT"; then
terraform workspace new "$ENVIRONMENT"
fi
terraform workspace select "$ENVIRONMENT"
terraform get
terraform plan -var-file=$1
terraform apply -var-file=$1
```

## Example
```hcl-terraform
module "api_lambda_dynamodb" {
source = "crisboarna/terraform-aws-api-gateway-lambda-dynamodb"
version = "1.16.0"

#Global
region = "eu-west-1"
project = "Awesome Project"

#API Gateway
api_gw_method = "POST"

#Lambda
lambda_function_name = "Awesome Endpoint"
lambda_description = "Awesome HTTP Endpoint Lambda"
lambda_runtime = "nodejs8.10"
lambda_handler = "dist/bin/lambda.handler"
lambda_timeout = 30
lambda_code_s3_bucket = "awesome-project-bucket"
lambda_code_s3_key = "awesome-project.zip"
lambda_code_s3_storage_class = "ONEZONE_IA"
lambda_code_s3_bucket_visibility = "private"
lambda_zip_path = "../../awesome-project.zip"
lambda_memory_size = 256
lambda_vpc_security_group_ids = [aws_security_group.vpc_security_group.id]
lambda_vpc_subnet_ids = [aws_subnet.vpc_subnet_a.id]
lambda_layers = [data.aws_lambda_layer_version.layer.arn]

#DynamoDB
dynamodb_table_properties = [
{
name = "Awesome Project Table 1"
},
{
name = "Awesome Project Table 2",
read_capacity = 2,
write_capacity = 3,
hash_key = "KEY"
range_key = ""
stream_enabled = "true"
stream_view_type = "NEW_IMAGE"
}
]

dynamodb_table_attributes = [[
{
name = "KEY"
type = "S"
}],[
{
name = "PRIMARY_KEY"
type = "N"
}, {
name = "SECONDARY_KEY"
type = "S"
}
]]

dynamodb_table_secondary_index = [[
{
name = "GameTitleIndex"
hash_key = "GameTitle"
range_key = "TopScore"
write_capacity = 10
read_capacity = 10
projection_type = "INCLUDE"
non_key_attributes = ["UserId"]
}
]]

dynamodb_policy_action_list = ["dynamodb:PutItem", "dynamodb:DescribeTable", "dynamodb:DeleteItem", "dynamodb:GetItem", "dynamodb:Scan", "dynamodb:Query"]

#Tags
tags = {
project = "Awesome Project"
managedby = "Terraform"
}

#Lambda Environment variables
environment_variables = {
NODE_ENV = "production"
}
}
```