aa-aws-terraform-demo

Contents 📕

• Contents
• Requirements
• Design
• Testing

Requirements 📋

Functional/Architectural Requirements:

Deliver four backend endpoints (no front end, no HTML) that will be the start of user management for a new application. The endpoints shall create, read, update, and delete new users. The properties of a user object are left up to you. Enable appropriate authentication and validation on these endpoints. The user’s data shall be stored in DynamoDB with primary and sort keys named ‘_pk0’ and _’sk0’ respectively. Deployment of these APIs can be provided through your preferred Infrastructure-As-Code framework.

Required AWS services:

• API Gateway
• DynamoDB

Prohibited AWS services:

• Lambda

All other AWS services optional per your design.

Deliveries:

• IAC code to deploy.
• Instructions so we can deploy and test the solution.
• Postman file we can use to exercise the deployed endpoints

Design 🔩

Project

Currenlty configurations:

• API Gateway manage all endpoints
• Backend integration via AWS
• Authentication via IAM
• Validation via input mapping types

Future options:

• Find ways to simplify the endpoint infrastructure by better use of vars
• Determine if a Terraform module can replace any of the pile of resources used, for best practice
• Use tagging more consistenly
• Verify logging meets requirements

User table

Because the design specified storing user data with primary and sort keys, it implies the primary key holds data in a one-to-many relationship, along with the sort key. The data to store was not specified, so I'll make some up.

Required:

• pk - starship (holds a crew)
• sk - crewperson's name

Optional:

• email address
• subscribed to email updates

Terraform

• DynamoDB module for user storage setup
  • terraform-aws-modules/dynamodb-table/aws
• API Gateway-DynamoDB CRUD integrations, via the "AWS" integration type
  • aws_api_gateway_integration
• API Gateway endpoint configurations, authorization via "AWS_IAM" over a Lambda authorizer as per requirements
  • aws_api_gateway_method
• Cloudwatch logging setup for debugging
  • Various resources

Testing 🧪

Setup

1. Deploy the Terraform

   cd terraform
   terraform init && terraform apply
   

2. Copy the invoke_url Terraform output
3. Open Postman and start a new request
4. Paste in the URL
5. Log into AWS and create a new access key in IAM (or use an existing one)
6. In your Postman request, switch to the Authorization tab and select the AWS Signature type
7. Paste in the AccessKey and SecretKey
8. Continue with further setup described in one of the CRUD methods below

POST (Create)

Post requests create a new record.

• Request type is POST
• Content-Type header is application/json
• Request body:

  {
      "starship": "NCC-1701-D",          // required string (_pk0)
      "name": "Geordi",                  // required string (_sk0)
      "email": "[email protected]", // optional string
      "subscribed": true                 // optional bool
  }

GET (Read)

Get requests return all the records in the table.

• Request type is GET
• Request body is none

PUT (Update)

Put requests update a record.

• Request type is PUT
• Content-Type header is application/json
• Request body:

  {
      "starship": "NCC-1701-D",                 // required string (_pk0)
      "name": "Geordi",                         // required string (_sk0)
      "email": "[email protected]", // string to update
      "subscribed": false                       // bool to update
  }

DELETE (Destroy)

Delete requests remove a record.

• Request type is DELETE
• Content-Type header is application/json
• Request body:

  {
      "starship": "NCC-1701-D", // required string (_pk0)
      "name": "Geordi"          // required string (_sk0)
  }