AWS Cloud Development Kit (AWS CDK)

The AWS Cloud Development Kit (AWS CDK) is a software development framework for defining cloud infrastructure in code.

Getting Started

Prerequisites

Make sure you have the following prerequisites installed:

• Node.js 8.11.0
• AWS CLI (only needed if you intend to download the release from S3).
• The development toolchain of the language you intend to use (TypeScript, Python, Java, .NET, Ruby...)

Downloading the bits

The CDK is distributed as a single zip file which contains:

1. The CDK command-line toolkit
2. Documentation HTML
3. JavaScript/TypeScript Framework and AWS Constructs
4. Java Framework and AWS Constructs

You can either download the zip file from the Releases page on GitHub or if you prefer, download them bits from S3 using the URL provided by our team.

To download from S3:

aws s3 cp <s3-url> ~/aws-cdk.zip

Install to ~/.cdk

Once you've downloaded the bits, install them into ~/.cdk and make sure that ~/.cdk/bin is in your PATH:

Linux/MacOS (bash/zsh)

# Install to ~/.cdk
rm -fr ~/.cdk
mkdir ~/.cdk
unzip <path-to-zip-file> -d ~/.cdk

# Add ~/.cdk/bin to your PATH
echo 'PATH=$PATH:$HOME/.cdk/bin' >> ~/.bashrc
echo 'PATH=$PATH:$HOME/.cdk/bin' >> ~/.zshrc

Windows (PowerShell)

# Install to ~/.cdk
Remove-Item -Force -Recurse ~/.cdk
New-Item -Type Directory ~/.cdk
Expand-Archive -Path <path-to-zip-file> -DestinationPath ~/.cdk

# Add ~/.cdk/bin to your PATH
$profilePath = Join-Path ([Environment]::GetFolderPath([Environment+SpecialFolder]::MyDocuments)) "Profile.ps1"
Add-Content -Path $profilePath -Value '$env:Path = "$env:Path;$env:UserProfile\.cdk\bin"'

Install the command-line toolkit and docs

Install (or update) aws-cdk and aws-cdk-docs globally

y-npm install --global aws-cdk aws-cdk-docs

y-npm is an npm wrapper which allows installing npm modules from a local repository located at ~/.cdk/y/npm. y-npm will fall back to the public npm repository if a module cannot be found locally.

To check which CDK version you have installed:

cdk --version

Viewing Documentation

To view CDK documentation bundled with the release, run:

cdk docs

Next steps?

Follow the "Getting Started" guide in CDK docs to initialize your first CDK project and deploy it to an AWS account.

Verifying the integrity of your download

You can verify that your download is complete and correct by validating its signature against our public signing key. To do so, you need the following things:

• GNU Privacy Guard needs to be installed.
• Download our public key: https://s3.amazonaws.com/aws-cdk-beta/cdk-team.asc
• Make sure you have downloaded both aws-cdk-x.y.z.zip and aws-cdk-x.y.z.zip.sig.

Then run the following commands:

gpg --import cdk-team.asc
gpg --verify aws-cdk-x.y.z.zip.sig aws-cdk-x.y.z.zip

If everything is correct, the output will contain the line:

gpg: Good signature from "AWS CDK Team <aws-cdk@amazon.com>"

If you obtained via the above URL, you can ignore the following message:

gpg: WARNING: This key is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the owner.

Development

See CONTRIBUTING.

License

Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.

See LICENSE file for license terms.