How ngl321/aws-cdk-examples works
Project type and purpose
• This is a monorepo containing AWS CDK example applications in multiple languages (TypeScript, Python, Java, C#, Go).
• Its purpose is to demonstrate common AWS infrastructure patterns (load balancers, Lambda functions, ECS, Step Functions, etc.) for learners and contributors.
File structure
• Top-level directories:
• .github/workflows – CI/CD pipeline definitions (build, test, extract snippets)
• scripts – language-specific build & synth scripts
• csharp, go, java, python, typescript – language-scoped example sets
• Under each language directory:
• Multiple example subdirectories, each containing a self-contained CDK app (cdk.json, source code, optional test or asset folder)
• README.md describing that example
• CI/CD config files (.github/workflows) orchestrate build → synth → test across languages using scripts/build-*.sh
README
• Explains the repository as an official AWS CDK Examples collection, organized by language, each example showing a single AWS pattern.
• No single runtime system; it’s an educational monorepo.
Diagramming guidance
a. Main components
1. Monorepo root
– Metadata & config (.editorconfig, LICENSE, NOTICE)
– CI/CD workflows (.github/workflows)
– Build & support scripts (scripts/)
2. Language workspaces (csharp/, go/, java/, python/, typescript/)
3. Example CDK apps (subfolders under each language)
4. External services: AWS CDK CLI, AWS account (for deploy), GitHub Actions
b. Relationships & interactions
– Developer commits → GitHub → triggers Actions workflows → runs scripts/build-*.sh → cdk synth / compile / test in each language workspace → outputs CloudFormation templates (synth) or test results
– Each language workspace interacts with AWS CDK library & language runtime (Node.js for TS, Python interpreter, .NET for C#, JVM for Java, Go compiler for Go)
c. Architectural patterns & principles
– Monorepo pattern: shared CI/CD for multiple language modules
– Consistent example scaffold: one CDK stack per example
– Modularization by language
d. Key technologies & frameworks
– AWS CDK library in each language
– GitHub Actions for CI
– Bash/PowerShell scripts for build orchestration
– Language-specific package managers (npm, pip, Maven, NuGet, Go modules)
Detailed capture of essential elements
• Directory layering: monorepo → languages → examples
• CI workflow sequence (checkout, install deps per language, synth, test)
• Examples by AWS service type (Lambda-based, ECS-based, Load Balancer-based) if desired for clarity