adam/engineering-handbook
1
0
Fork 0
mirror of https://github.com/Sea-Haven-Industries/engineering-handbook.git synced 2026-09-30 17:23:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
engineering-handbook/aws-infrastructure.md
Adam Moussa 0333e7f8f5 Add engineering handbook 
Conventions covering naming, git workflow, commit messages, pull
requests, code review, GitHub standards, AWS infrastructure, SAM
project layout, and secrets management. Commit messages section
adapted from RomuloOliveira/commit-messages-guide (CC-BY-4.0).
2026-05-02 16:42:44 -04:00

1.4 KiB
Raw Blame History

AWS Infrastructure

IaC Strategy

  • SAM is the default for new serverless stacks (Lambda + API Gateway + DynamoDB)
  • CDK only for complex infrastructure (ECS, VPCs, multi-service compositions)
  • Every deployed resource should be managed by CloudFormation
  • No manually-created Lambdas, roles, or other resources outside of IaC

Lambda Defaults

These apply to every Lambda in every project. Verify, don't assume.

Setting Value
Runtime Python 3.12 or Node 22.x
Architecture arm64
Log retention 60 days (explicit in IaC template)
Naming kebab-case, matching the stack name prefix

Never rely on the CloudWatch default for log retention. Always set RetentionInDays explicitly in the template.

CloudFormation Outputs

Every stack should export:

  • Function ARNs
  • Any externally-consumable URLs (API Gateway endpoints, etc.)

S3

  • Every non-CloudFormation bucket must have Purpose and ManagedBy tags
  • Define lifecycle policies in the IaC template
  • Use Glacier Deep Archive for archival data

README

Every repo must have a README that accurately describes:

  • Project architecture
  • Lambdas and services
  • Data flow
  • Configuration requirements

Update the README in the same commit where functionality changes. If a README is missing or outdated when you start working on a project, fix it as part of the current work.