Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into benisrae/nested-stacks
Browse files Browse the repository at this point in the history
  • Loading branch information
Elad Ben-Israel committed Jul 15, 2019
2 parents 399f24c + f0fec54 commit bfaaecb
Show file tree
Hide file tree
Showing 665 changed files with 19,919 additions and 8,103 deletions.
5 changes: 5 additions & 0 deletions .gitallowed
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ account: '234567890123'
account: '000000000000'
account: '111111111111'
account: '333333333333'

# used in physical names tests in @aws-cdk/core
account: '012345678912'
account: '012345678913'

# Account patterns used in the CHANGELOG
account: '123456789012'
123456789012
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@
*.zip binary
*.png binary
*.jpg binary
*.tgz binary
*.tar.gz binary
8 changes: 4 additions & 4 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#
# @See https://help.github.com/articles/about-codeowners/

* @awslabs/aws-cdk-team
/docs/ @awslabs/aws-cdk-team @Doug-AWS
/packages/@aws-cdk/aws-code*/ @awslabs/aws-cdk-team @RomainMuller @skinny85
/packages/@aws-cdk/aws-ecs/ @awslabs/aws-cdk-team @SoManyHs
* @aws/aws-cdk-team
/docs/ @aws/aws-cdk-team @Doug-AWS
/packages/@aws-cdk/aws-code*/ @aws/aws-cdk-team @RomainMuller @skinny85
/packages/@aws-cdk/aws-ecs/ @aws/aws-cdk-team @SoManyHs
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ labels: needs-triage
- [ ] :beetle: bug report
- [ ] :rocket: feature request
- [ ] :books: construct library gap
- [ ] :phone: security issue or vulnerability => Please see [policy](https://github.com/awslabs/aws-cdk/security/policy)
- [ ] :phone: security issue or vulnerability => Please see [policy](https://github.com/aws/aws-cdk/security/policy)
- [ ] :question: support request => Please see note at the top of this template.


Expand All @@ -27,7 +27,7 @@ labels: needs-triage


* **Please tell us about your environment:**

- CDK CLI Version: xx.xx.xx
- Module Version: xx.xx.xx
- OS: [all | Windows 10 | OSX Mojave | Ubuntu | etc... ]
Expand Down
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/general-issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: General Issues
about: Please use this template to submit issues for review
title: ''
labels: needs-triage
assignees: ''

---

**Note: for support questions, please first reference our [documentation](https://docs.aws.amazon.com/cdk/api/latest), then use [Stackoverflow](https://stackoverflow.com/questions/ask?tags=aws-cdk)**. This repository's issues are intended for feature requests and bug reports.

* **I'm submitting a ...**
- [ ] :beetle: bug report
- [ ] :rocket: feature request
- [ ] :books: construct library gap
- [ ] :phone: security issue or vulnerability => Please see [policy](https://github.com/aws/aws-cdk/security/policy)
- [ ] :question: support request => Please see note at the top of this template.


* **What is the current behavior?**
*If the current behavior is a :beetle:bug:beetle:: Please provide the steps to reproduce*



* **What is the expected behavior (or behavior of feature suggested)?**



* **What is the motivation / use case for changing the behavior or adding this feature?**



* **Please tell us about your environment:**

- CDK CLI Version: xx.xx.xx
- Module Version: xx.xx.xx
- OS: [all | Windows 10 | OSX Mojave | Ubuntu | etc... ]
- Language: [all | TypeScript | Java | Python ]


* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. associated pull-request, stackoverflow, gitter, etc)
4 changes: 1 addition & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
----

Please read the [contribution guidelines](https://github.com/awslabs/aws-cdk/blob/master/CONTRIBUTING.md) and follow the pull-request checklist.
Please read the [contribution guidelines](https://github.com/aws/aws-cdk/blob/master/CONTRIBUTING.md) and follow the pull-request checklist.

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

----
2,058 changes: 1,148 additions & 910 deletions CHANGELOG.md

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ BREAKING CHANGE: Description of what broke and how to achieve this behavior now
same branch. Usually all these are going to be squashed when you merge to master. The commit messages should be hints
for you when you finalize your merge commit message.
* Make sure to update the PR title/description if things change. The PR title/description are going to be used as the
commit title/message and will appear in the CHANGELOG, so maintain them all the way throughout the process.
commit title/message and will appear in the CHANGELOG, so maintain them all the way throughout the process.



Expand All @@ -176,7 +176,7 @@ The CDK is a big project, and, at the moment, all of the CDK modules are mastere
to maintain integrity in the early stage of the project where things constantly change across the stack. In the future
we believe many of these modules will be extracted to their own repositories.

Another complexity is that the CDK is packaged using [jsii](https://github.com/awslabs/jsii) to multiple programming
Another complexity is that the CDK is packaged using [jsii](https://github.com/aws/jsii) to multiple programming
languages. This means that when a full build is complete, there will be a version of each module for each supported
language.

Expand Down Expand Up @@ -317,7 +317,7 @@ This section includes step-by-step descriptions of common workflows.
Clone the repo:

```console
$ git clone git@github.com/awslabs/aws-cdk
$ git clone git@github.com/aws/aws-cdk
$ cd aws-cdk
```

Expand All @@ -341,7 +341,7 @@ $ ./pack.sh
Clone the repo:

```console
$ git clone git@github.com/awslabs/aws-cdk
$ git clone git@github.com/aws/aws-cdk
$ cd aws-cdk
```

Expand Down Expand Up @@ -545,5 +545,5 @@ $ CDK_TEST_BUILD=false lr test
* [Samples](https://github.com/aws-samples/aws-cdk-examples): includes sample code in multiple languages
* [Workshop](https://github.com/aws-samples/aws-cdk-intro-workshop): source for https://cdkworkshop.com
* [Developer Guide](https://github.com/awsdocs/aws-cdk-guide): markdown source for developer guide
* [jsii](https://github.com/awslabs/jsii): the technology we use for multi-language support. If you are looking to help us support new languages, start there.
* [jsii](https://github.com/aws/jsii): the technology we use for multi-language support. If you are looking to help us support new languages, start there.

2 changes: 1 addition & 1 deletion MANUAL_INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The CDK is also distributed as a single zip file which contains:
3. Java Framework and AWS Constructs

You can download the zip file from the
[Releases](http://github.com/awslabs/aws-cdk/releases) page on GitHub.
[Releases](http://github.com/aws/aws-cdk/releases) page on GitHub.

The zip file comes with a signature so the integrity of the download
can be verified (see below).
Expand Down
88 changes: 58 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,45 @@
# AWS Cloud Development Kit (AWS CDK)

![Build Status](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiRUlEQk1UWVhQRDduSy9iWWtpa012bmJSU0t2aXpCeEtTT2VpWDhlVmxldVU0ZXBoSzRpdTk1cGNNTThUaUtYVU5BMVZnd1ZhT2FTMWZjNkZ0RE5hSlpNPSIsIml2UGFyYW1ldGVyU3BlYyI6IllIUjJNUEZKY3NqYnR6S3EiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
[![Build Status](https://travis-ci.org/awslabs/aws-cdk.svg?branch=master)](https://travis-ci.org/awslabs/aws-cdk)
[![Build Status](https://travis-ci.org/aws/aws-cdk.svg?branch=master)](https://travis-ci.org/aws/aws-cdk)
[![Version](https://badge.fury.io/js/aws-cdk.svg)](https://badge.fury.io/js/aws-cdk)
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/awslabs/aws-cdk)
[![NPM version](https://badge.fury.io/js/aws-cdk.svg)](https://badge.fury.io/js/aws-cdk)
[![PyPI version](https://badge.fury.io/py/aws-cdk.core.svg)](https://badge.fury.io/py/aws-cdk.core)
[![NuGet version](https://badge.fury.io/nu/Amazon.CDK.svg)](https://badge.fury.io/nu/Amazon.CDK)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/software.amazon.awscdk/core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/software.amazon.awscdk/core)

The **AWS Cloud Development Kit (AWS CDK)** is an open-source software development
framework to define cloud infrastructure in code and provision it through AWS CloudFormation.
The CDK integrates fully with AWS services and offers a higher level object-oriented
abstraction to define AWS resources imperatively. Using the CDK’s library of
infrastructure [constructs], you can easily encapsulate AWS best practices in your
infrastructure definition and share it without worrying about boilerplate logic. The
CDK improves the end-to-end development experience because you get to use the power
of modern programming languages to define your AWS infrastructure in a predictable
and efficient manner.

The following languages are currently supported:
It offers a high-level object-oriented abstraction to define AWS resources imperatively using
the power of modern programming languages. Using the CDK’s library of
infrastructure constructs, you can easily encapsulate AWS best practices in your
infrastructure definition and share it without worrying about boilerplate logic.

* JavaScript, TypeScript
* Python
* Java
* .NET
The CDK is available in the following languages:

* JavaScript, TypeScript ([Node.js ≥ 8.11.x](https://nodejs.org/en/download))
* Python ([Python ≥ 3.6](https://www.python.org/downloads/))
* Java (Developer Preview, [Java ≥ 8](https://www.oracle.com/technetwork/java/javase/downloads/index.html) and [Maven ≥ 3.5.4](https://maven.apache.org/download.cgi))
* .NET (Developer Preview, [.NET Core ≥ 2.0](https://dotnet.microsoft.com/download))

The CDK is currently in developer preview and we look forward to community feedback and collaboration!

[Developer Guide] |
[Tutorial] |
-------

[Developer Guide](https://docs.aws.amazon.com/cdk/latest/guide) |
[Getting Started](https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html) |
[API Reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-construct-library.html) |
[Examples](https://github.com/aws-samples/aws-cdk-examples) |
[Getting Help](#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].
Developers use the [CDK framework] in one of the
supported programming languages to define reusable cloud components called [constructs], which
are composed together into [stacks], forming a "CDK app".

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"
They then use the [AWS CDK CLI] to interact with their CDK app. The CLI 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
Expand All @@ -45,30 +48,53 @@ 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.

[cdk framework]: https://docs.aws.amazon.com/cdk/api/latest/
[constructs]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html
[stacks]: https://docs.aws.amazon.com/cdk/latest/guide/apps_and_stacks.html#stacks
[apps]: https://docs.aws.amazon.com/cdk/latest/guide/apps_and_stacks.html#apps
[Developer Guide]: https://docs.aws.amazon.com/cdk/latest/guide
[Tutorial]: https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#hello_world_tutorial
[AWS CDK Toolkit]: https://docs.aws.amazon.com/cdk/latest/guide/tools.html
[AWS CDK CLI]: https://docs.aws.amazon.com/cdk/latest/guide/tools.html
[AWS Construct Library]: https://docs.aws.amazon.com/cdk/latest/guide/aws_construct_lib.html

## Getting Started
## At a glance

* See [Manual Installation](./MANUAL_INSTALLATION.md) for installing the CDK from a signed .zip file

Install or update the [AWS CDK Toolkit] from npm (requires [Node.js ≥ 8.11.x](https://nodejs.org/en/download)):
Install or update the [AWS CDK CLI] from npm (requires [Node.js ≥ 8.11.x](https://nodejs.org/en/download)):

```bash
$ npm i -g aws-cdk
```

(See [Manual Installation](./MANUAL_INSTALLATION.md) for installing the CDK from a signed .zip file).

Initialize a project:

```bash
$ mkdir hello-cdk
$ cd hello-cdk
$ cdk init app --language=typescript (or --language=java, ...)
$ cdk init sample-app --language=typescript
```

This creates a sample project looking like this:

```ts
export class HelloCdkStack extends cdk.Stack {
constructor(scope: cdk.App, id: string, props?: cdk.StackProps) {
super(scope, id, props);

const queue = new sqs.Queue(this, 'HelloCdkQueue', {
visibilityTimeout: cdk.Duration.seconds(300)
});

const topic = new sns.Topic(this, 'HelloCdkTopic');

topic.addSubscription(new subs.SqsSubscription(queue));
}
}
```

Deploy this to your account:

```bash
$ cdk deploy
```

Expand All @@ -78,7 +104,7 @@ Use the `cdk` command-line toolkit to interact with your project:
* `cdk synth`: synthesizes an AWS CloudFormation template for your app
* `cdk diff`: compares your app with the deployed stack

For a detailed walkthrough, see [Tutorial] in the AWS CDK [Developer Guide].
For a detailed walkthrough, see the [tutorial] in the AWS CDK [Developer Guide].

## Getting Help

Expand All @@ -90,7 +116,7 @@ for tracking bugs and feature requests.
* Come join the AWS CDK community on [Gitter](https://gitter.im/awslabs/aws-cdk)
* Open a support ticket with [AWS Support](https://console.aws.amazon.com/support/home#/)
* If it turns out that you may have found a bug,
please open an [issue](https://github.com/awslabs/aws-cdk/issues/new)
please open an [issue](https://github.com/aws/aws-cdk/issues/new)

## Contributing

Expand All @@ -103,3 +129,5 @@ environment and submit code.
The AWS CDK is distributed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

See [LICENSE](./LICENSE) and [NOTICE](./NOTICE) for more information.

[Tutorial]: https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#hello_world_tutorial
6 changes: 3 additions & 3 deletions build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
set -euo pipefail

bail="--bail"
run_tests="true"
runtarget="build+test"
while [[ "${1:-}" != "" ]]; do
case $1 in
-h|--help)
Expand All @@ -16,7 +16,7 @@ while [[ "${1:-}" != "" ]]; do
export CDK_BUILD="--force"
;;
--skip-test|--skip-tests)
run_tests="false"
runtarget="build"
;;
*)
echo "Unrecognized parameter: $1"
Expand Down Expand Up @@ -53,7 +53,7 @@ trap "rm -rf $MERKLE_BUILD_CACHE" EXIT

echo "============================================================================================="
echo "building..."
time lerna run $bail --stream build+test || fail
time lerna run $bail --stream $runtarget || fail

/bin/bash scripts/check-api-compatibility.sh

Expand Down
2 changes: 1 addition & 1 deletion bump.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export NODE_OPTIONS="--max-old-space-size=4096 ${NODE_OPTIONS:-}"

/bin/bash ./install.sh

lerna publish --force-publish=* --skip-npm --skip-git --repo-version ${ver}
npx lerna publish --force-publish=* --skip-npm --skip-git --repo-version ${ver}

# Update CHANGELOG.md only at the root
cat > /tmp/context.json <<HERE
Expand Down
Loading

0 comments on commit bfaaecb

Please sign in to comment.