Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/okruti-raghuraj/aws-1/llms.txt

Use this file to discover all available pages before exploring further.

Before you can deploy the self-mutating CDK pipeline to your AWS account, you need to have the correct toolchain installed locally, an AWS account with sufficient permissions, and a GitHub repository ready to serve as the pipeline source. This page walks through every requirement so you can confirm your environment is ready before running any commands.

​
Required Tools

Install each of the following tools in order. All subsequent setup steps assume these are available on your PATH.
1

Node.js 14 or later

The CDK CLI and the TypeScript compilation step both require Node.js. Download and install the latest LTS release from nodejs.org. Verify your version:
node --version
# v14.x.x or higher required
npm is bundled with Node.js and does not need a separate install.
2

AWS CLI v2

The CDK uses the AWS CLI under the hood to resolve credentials and bootstrap your account. See the AWS CLI Setup page for full installation and configuration instructions.
aws --version
# aws-cli/2.x.x ...
3

AWS CDK CLI v2.20.0

The project pins CDK to version 2.20.0. Install the matching CLI globally so that local synthesis and diff commands match the version used in the pipeline.
npm install -g aws-cdk@2.20.0
cdk --version
# 2.20.0 (build ...)
4

TypeScript 3.9+

The project is written in TypeScript ~3.9.7. Install the TypeScript compiler globally so you can run tsc outside of the npm scripts if needed.
npm install -g typescript
tsc --version
# Version 3.9.x
5

Project dependencies

Inside the aws-cdk-pipeline/ directory, install all local npm dependencies declared in package.json:
npm ci
npm ci performs a clean, reproducible install that respects the lock file — the same command the pipeline runs during synthesis.

​
AWS Account and IAM Permissions

You need access to an AWS account with programmatic credentials. For the initial bootstrap and first stack deployment you require broad permissions — an IAM user or role with the AdministratorAccess managed policy is the simplest starting point. After the first manual cdk deploy, all subsequent deployments are driven by the pipeline’s own execution role. You can tighten your personal IAM permissions once the pipeline is running.
CDK bootstrap must be run once per AWS account per region before the first deploy. It provisions the S3 bucket, ECR repository, and IAM roles that CDK needs to store assets and perform deployments. Run:
cdk bootstrap aws://YOUR_ACCOUNT_ID/YOUR_REGION
For this project the default target is account 602143770054 in region ap-south-1. Replace these values with your own account ID and preferred region.

​
GitHub Requirements

The pipeline sources code directly from GitHub using AWS CodeStar Connections. Before deploying you need:
  • A GitHub repository that will hold your CDK application code. The pipeline is currently configured to pull from RaghurajSingh/SMS on the aws-pipeline branch — you will replace this with your own repository and branch during configuration.
  • A CodeStar Connection approved in the AWS Console. The first time you deploy, AWS will prompt you to authorize the GitHub connection in the CodeStar Connections console under Developer Tools → Connections. The pipeline will stay in a Pending state until this authorization is completed.
Once your tools are installed and your AWS credentials are configured, head to Configuration to update the account ID, region, and GitHub repository settings before deploying.

Build docs developers (and LLMs) love

Get started for freeTalk to us