README.md

AWS Cloud Development Kit (AWS CDK)

The AWS Cloud Development Kit (AWS CDK) is an infrastructure modeling framework that allows you to define your cloud resources using an imperative programming interface. The CDK is currently in developer preview. We look forward to community feedback and collaboration.

User Guide | Getting Started | API Reference | Getting Help

Developers can use one of the supported programming languages to define reusable cloud components called constructs, which are composed together into stacks and apps.

The AWS CDK Toolkit is a command-line tool for interacting with CDK apps. It allows developers to synthesize artifacts such as AWS CloudFormation Templates, deploy stacks to development AWS accounts and "diff" against a deployed stack to understand the impact of a code change.

The AWS Construct Library includes a module for each AWS service with constructs that offer rich APIs that encapsulate the details of how to use AWS. The AWS Construct Library aims to reduce the complexity and glue-logic required when integrating various AWS services to achieve your goals on AWS.

Getting Started

• For a detailed walkthrough, see Getting Started in the AWS CDK User Guide
• See Manual Installation for installing the CDK from a signed .zip file

Install the AWS CDK Toolkit from npm (requires Node.js ≥ 8.11.x):

$ npm i -g aws-cdk

Initialize a project:

$ mkdir hello-cdk
$ cd hello-cdk
$ cdk init app --language=typescript
# or
$ cdk init app --language=java
# more languages (coming soon)...

Use the cdk command-line toolkit to interact with your project:

• cdk deploy: deploys your app into an AWS account
• cdk synth: synthesizes an AWS CloudFormation template for your app
• cdk diff: compares your app with the deployed stack

Read the docs:

$ cdk docs

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests.

• Ask a question on Stack Overflow and tag it with aws-cdk
• Come join the AWS CDK community on Gitter
• Open a support ticket with AWS Support
• If it turns out that you may have found a bug, please open an issue

Contributing

We welcome community contributions and pull requests. See CONTRIBUTING for information on how to set up a development environment and submit code.

License

This AWS CDK is distributed under the Apache License, Version 2.0.

See LICENSE and NOTICE for more information.