The perfect starter kit to create and deploy an AWS CDK App using Python on your AWS account in less than 5 minutes using GitHub actions!
Welcome to the starting line of your next AWS CDK project. This repository is crafted to supercharge your project's setup with AWS CDK Python, projen, and GitHub actions, ensuring a smooth and efficient deployment to your AWS account.
- ⚡ Rapid Setup: Jumpstart your project within minutes by tweaking a single configuration file. Spend less time on boilerplate and more on building.
- 🤹♂️ Multi-Account Flexibility: Ready for enterprises, this starter kit supports multi-account setups right from the start, enabling scalable and segregated cloud environments.
- 🤖 Automated Deploy Pipelines: Embrace CI/CD with out-of-the-box GitHub Actions workflows, automating your deployment processes for efficiency and reliability.
- 🏗️ Project structure: The project is structured in a clean and intuitive way that allows you to easily manage your constructs and stacks for this CDK App.
- 🛡️ Seamless Security: Leverage OpenID Connect for secure AWS deployments. Authenticate your GitHub Actions workflows directly with AWS, eliminating the need for stored credentials or long-lived secrets.
- 📦 Improved Dependency Management: Dependencies and virtualenvs are managed with Poetry.
- 📏 Fast Linting & formatting: Ruff is installed as a dev dependency right out of the box!
- 🚀 Enhanced Pull Requests: Benefit from a built-in, fancy pull request template, making code reviews more structured and informative.
All the config that is needed to personalise the CDK App to your environment is defined in the .projenrc.py file.
To get started, follow these steps:
-
Fork / clone this repository.
-
Add a Personal Access Token to the repository settings on GitHub, follow these instructions for setting up a fine-grained personal access token.
-
Install the AWS CDK CLI and projen:
npm install -g aws-cdk projen -
Install the projects dependencies using:
poetry install -
Customize the AWS Region and Account IDs in the .projenrc.py file to match your AWS setup:
# Define the AWS region for the CDK app and github workflows
# Default to us-east-1 if AWS_REGION is not set in your environment variables
aws_region = os.getenv("AWS_REGION", "us-east-1")
# Set the CDK_DEFAULT_REGION environment variable for the projen tasks,
# so the CDK CLI knows which region to use
project.tasks.add_environment("CDK_DEFAULT_REGION", aws_region)
# Define the target AWS accounts for the different environments
target_accounts = {
"dev": "987654321012",
"test": "123456789012",
"staging": None,
"production": None,
}-
Run
projento generate the github actions workflow files. -
AWS CLI Authentication: Ensure you're logged into an AWS Account (one of the ones you configured in step 4) via the AWS CLI. If you haven't set up the AWS CLI, then follow this guide)
-
Deploy the CDK toolkit stack to your AWS environment with
cdk bootstrapif it's not already set up. -
Deploy the GitHub OIDC Stack to enable GitHub Actions workflow permissions for AWS deployments. For instance, if you set up a
devenvironment, executeprojen dev:deploy. -
Commit and push your changes to the
mainbranch to trigger the CDK deploy pipeline in GitHub.
Congratulations 🎉! You've successfully set up your project.
When working on smaller projects using infrastructure as code, where you deploy single applications that don’t demand extensive maintenance or collaboration from multiple teams, it’s recommended to structure your AWS CDK project in a way that enables you to deploy both the application and infrastructure using a single stack.
However, as projects evolve to encompass multiple microservices and a variety of stateful resources (e.g., databases), the complexity inherently increases.
In such cases, adopting a more sophisticated AWS CDK project organization becomes critical. This ensures not only the ease of extensibility but also the smooth deployment of each component, thereby supporting a more robust development lifecycle and facilitating greater operational efficiency.
To cater to these advanced needs, your AWS CDK project should adopt a modular structure. This is where the AWS CDK Python Starterkit shines ✨.
Here’s a closer look at how this structure enhances maintainability and scalability:
.
├── cdk.json
├── poetry.lock
├── pyproject.toml
├── README.md
├── src
│ ├── __init__.py
│ ├── app.py
│ ├── assets
│ │ ├── ecs
│ │ │ └── hello-world
│ │ │ └── Dockerfile
│ │ └── lambda
│ │ └── hello-world
│ │ └── lambda_function.py
│ ├── bin
│ │ ├── cicd_helper.py
│ │ ├── env_helper.py
│ │ └── git_helper.py
│ ├── custom_constructs
│ │ ├── __init__.py
│ │ ├── base_construct.py
│ │ ├── network_construct.py
│ │ └── README.md
│ └── stacks
│ ├── __init__.py
│ ├── base_stack.py
│ ├── github_oidc_stack.py
│ └── README.md
└── tests
├── __init__.py
└── test_example.pyAs you can see in the above tree diagram, the way this project is setup it tries to segment it into logical units, such as constructs for reusable infrastructure patterns, stacks for deploying groups of resources and assets for managing source code of containers and lambda functions.
Here is a brief explanation of what each section does:
src/assets: Organizes the assets for your Lambda functions and ECS services, ensuring that the application code is neatly encapsulated with the infrastructure code.src/bin: Contains utility scripts (e.g.,cicd_helper.py,env_helper.py,git_helper.py) that streamline environment setup and integration with CI/CD pipelines.src/custom_constructs: Houses the core building blocks of your infrastructure. These constructs can be composed into higher-level abstractions, promoting reusability across different parts of your infrastructure. Check out the README in the constructs folder to read how you can utilize environment-aware configurations.src/stacks: Dedicated to defining stacks that represent collections of AWS resources (constructs). This allows for logical grouping of related resources, making it simpler to manage deployments and resource dependencies. Check out the README in the stacks folder to read how you can instantiate new stacks.src/lib/main.ts: This is where the CDK app is instantiated.test: Is the location to store your unit or integration tests (powered by jest)
Tip
Supercharge Your AWS Infrastructure with Towards the Cloud. We ship well-architected, resilient, and cost-optimized AWS solutions designed to scale using Infrastructure as Code (IaC), tailoring cloud-native systems for businesses of all sizes.
Our Approach:
- Tailored AWS Solutions: Custom-built for your unique business needs
- Future-Proof Architecture: Scalable designs that grow with you
- Empowerment Through Ownership: Your vision, your infrastructure, our expertise
Why Choose Us:
- 10+ Years of AWS Experience
- 7x AWS Certified, including DevOps Engineer & Solutions Architect Professional
- Proven Track Record: 40% Average Reduction in Operational Costs
Ready to elevate your AWS CDK Infrastructure?
☁️ Discover more about my one-person business: Towards the Cloud
Hi, I'm Danny – AWS expert and founder of Towards the Cloud. With over a decade of hands-on experience, I specialized myself in deploying well-architected, highly scalable and cost-effective AWS Solutions using Infrastructure as Code (IaC).
- AWS CDK Proficiency: I bring deep AWS CDK knowledge to the table, ensuring your infrastructure is not just maintainable and scalable, but also fully automated.
- AWS Certified: Equipped with 7 AWS Certifications, including DevOps Engineer & Solutions Architect Professional, to ensure best practices across diverse cloud scenarios.
- Direct Access: You work with me, not a team of managers. Expect quick decisions and high-quality work.
- Tailored Solutions: Understanding that no two businesses are alike, I Custom-fit cloud infrastructure for your unique needs.
- Cost-Effective: I'll optimize your AWS spending without cutting corners on performance or security.
- Seamless CI/CD: I'll set up smooth CI/CD processes using GitHub Actions, making changes a breeze through Pull Requests.
My mission is simple: I'll free you from infrastructure headaches so you can focus on what truly matters – your core business.
Ready to unlock the full potential of AWS Cloud?
Looking for the TypeScript version of this AWS CDK starter kit? Check out the AWS CDK Starterkit for a tailored experience that leverages the full power of AWS CDK with TypeScript.
A heartfelt thank you to the creators of projen. This starter kit stands on the shoulders of giants, made possible by their pioneering work in simplifying cloud infrastructure projects!
