Skip to content

Commit bce41e4

Browse files
author
Niranjan Jayakar
committed
Merge branch 'master' into apigateway-configureImported
2 parents f7dfa3f + d21231f commit bce41e4

File tree

354 files changed

+13536
-2641
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

354 files changed

+13536
-2641
lines changed

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ what is the error message you are seeing?
3333

3434
- **CLI Version :**
3535
- **Framework Version:**
36+
- **Node.js Version:** <!-- Version of Node.js (run the command `node -v`) -->
3637
- **OS :**
37-
- **Language :**
38+
- **Language (Version):** <!-- [all | TypeScript (3.8.3) | Java (8)| Python (3.7.3) | etc... ] -->
3839

3940
### Other
4041

.github/ISSUE_TEMPLATE/general-issues.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ falling prey to the [X/Y problem][2]!
2525

2626
- **CDK CLI Version:** <!-- Output of `cdk version` -->
2727
- **Module Version:** <!-- Version of the module in question -->
28+
- **Node.js Version:** <!-- Version of Node.js (run the command `node -v`) -->
2829
- **OS:** <!-- [all | Windows 10 | OSX Mojave | Ubuntu | etc... ] -->
29-
- **Language:** <!-- [all | TypeScript | Java | Python ] etc... ] -->
30+
- **Language (Version):** <!-- [all | TypeScript (3.8.3) | Java (8)| Python (3.7.3) | etc... ] -->
3031

3132

3233
### Other information

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# VSCode extension
2-
.vscode/
2+
3+
# Store launch config in repo but not settings
4+
.vscode/settings.json
35
/.favorites.json
46

57
# TypeScript incremental build states

.mergify.yml

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ pull_request_rules:
66
label:
77
add: [ contribution/core ]
88
conditions:
9-
- author~=^(eladb|RomainMuller|garnaat|nija-at|shivlaks|skinny85|rix0rrr|NGL321|Jerry-AWS|SomayaB|MrArnoldPalmer|NetaNir|iliapolo)$
9+
- author~=^(eladb|RomainMuller|garnaat|nija-at|shivlaks|skinny85|rix0rrr|NGL321|Jerry-AWS|SomayaB|MrArnoldPalmer|NetaNir|iliapolo|njlynch)$
1010
- -label~="contribution/core"
1111
- name: automatic merge
1212
actions:
@@ -66,20 +66,7 @@ pull_request_rules:
6666
conditions:
6767
- author!=dependabot[bot]
6868
- author!=dependabot-preview[bot]
69-
# List out all the people whose work is okay to provisionally approve
70-
- author!=eladb
71-
- author!=RomainMuller
72-
- author!=garnaat
73-
- author!=nija-at
74-
- author!=shivlaks
75-
- author!=skinny85
76-
- author!=rix0rrr
77-
- author!=NGL321
78-
- author!=Jerry-AWS
79-
- author!=SomayaB
80-
- author!=MrArnoldPalmer
81-
- author!=NetaNir
82-
- author!=iliapolo
69+
- label!=contribution/core
8370
- base=master
8471
- -merged
8572
- -closed

.vscode/launch.json

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
// Has convenient settings for attaching to a NodeJS process for debugging purposes
9+
// that are NOT the default and otherwise every developers has to configure for
10+
// themselves again and again.
11+
"type": "node",
12+
"request": "attach",
13+
"name": "Attach to NodeJS",
14+
// If we don't do this, every step-into into an async function call will go into
15+
// NodeJS internals which are hard to step out of.
16+
"skipFiles": [
17+
"<node_internals>/**"
18+
],
19+
// Saves some button-pressing latency on attaching
20+
"stopOnEntry": false
21+
}
22+
]
23+
}

CHANGELOG.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,106 @@
22

33
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
44

5+
## [1.45.0](https://github.com/aws/aws-cdk/compare/v1.44.0...v1.45.0) (2020-06-09)
6+
7+
8+
### ⚠ BREAKING CHANGES
9+
10+
* **stepfunctions-tasks:** constructs for `SageMakerCreateTrainingJob` and
11+
`SageMakerCreateTransformJob` replace previous implementation that
12+
implemented `IStepFunctionsTask`.
13+
* **stepfunctions-tasks:** `volumeSizeInGB` property in `ResourceConfig` for
14+
SageMaker tasks are now type `core.Size`
15+
* **stepfunctions-tasks:** `maxPayload` property in `SagemakerTransformProps`
16+
is now type `core.Size`
17+
* **stepfunctions-tasks:** `volumeKmsKeyId` property in `SageMakerCreateTrainingJob` is now `volumeEncryptionKey`
18+
* **cognito:** `requiredAttributes` on `UserPool` construct is now replaced with `standardAttributes` with a slightly modified signature.
19+
* **rds:** DatabaseClusterProps.kmsKey has been renamed to storageEncryptionKey
20+
* **rds**: DatabaseInstanceNewProps.performanceInsightKmsKey has been renamed to performanceInsightEncryptionKey
21+
* **rds**: DatabaseInstanceSourceProps.secretKmsKey has been renamed to masterUserPasswordEncryptionKey
22+
* **rds**: DatabaseInstanceProps.kmsKey has been renamed to storageEncryptionKey
23+
* **rds**: DatabaseInstanceReadReplicaProps.kmsKey has been renamed to storageEncryptionKey
24+
* **rds**: Login.kmsKey has been renamed to encryptionKey
25+
26+
### Features
27+
28+
* **assert:** more powerful matchers ([#8444](https://github.com/aws/aws-cdk/issues/8444)) ([ed6f763](https://github.com/aws/aws-cdk/commit/ed6f763bddbb2090bbf07e5bbd6c7710a54dd33d))
29+
* **cloud9:** support AWS CodeCommit repository clone on launch ([#8205](https://github.com/aws/aws-cdk/issues/8205)) ([4781f94](https://github.com/aws/aws-cdk/commit/4781f94ee530ef66488fbf7b3728a753fa5718cd)), closes [#8204](https://github.com/aws/aws-cdk/issues/8204)
30+
* **codestar:** support the GitHubRepository resource ([#8209](https://github.com/aws/aws-cdk/issues/8209)) ([02ddab8](https://github.com/aws/aws-cdk/commit/02ddab8c1e76c59ccaff4f45986de68d538d54eb)), closes [#8210](https://github.com/aws/aws-cdk/issues/8210)
31+
* **cognito:** allow mutable attributes for requiredAttributes ([#7754](https://github.com/aws/aws-cdk/issues/7754)) ([1fabd98](https://github.com/aws/aws-cdk/commit/1fabd9819d4dbe64d175e73400078e435235d1d2))
32+
* **core,s3-assets,lambda:** custom asset bundling ([#7898](https://github.com/aws/aws-cdk/issues/7898)) ([888b412](https://github.com/aws/aws-cdk/commit/888b412797b2bcd7b8f1b8c5cbc0c25d94f91a5f))
33+
* **rds:** rename 'kmsKey' properties to 'encryptionKey' ([#8324](https://github.com/aws/aws-cdk/issues/8324)) ([4eefbbe](https://github.com/aws/aws-cdk/commit/4eefbbe612d4bd643bffd4dee525d88a921439cb))
34+
* **secretsmanager:** deletionPolicy for secretsmanager ([#8188](https://github.com/aws/aws-cdk/issues/8188)) ([f6fe36a](https://github.com/aws/aws-cdk/commit/f6fe36a0281a60ad65474b6ce0e22d0182ed2bea)), closes [#6527](https://github.com/aws/aws-cdk/issues/6527)
35+
* **secretsmanager:** Secret.grantRead() also gives DescribeSecret permissions ([#8409](https://github.com/aws/aws-cdk/issues/8409)) ([f44ae60](https://github.com/aws/aws-cdk/commit/f44ae607670bccee21dfd390effa7d0e8701efd4)), closes [#6444](https://github.com/aws/aws-cdk/issues/6444) [#7953](https://github.com/aws/aws-cdk/issues/7953)
36+
* **stepfunctions-tasks:** task constructs for creating and transforming SageMaker jobs ([#8391](https://github.com/aws/aws-cdk/issues/8391)) ([480d4c0](https://github.com/aws/aws-cdk/commit/480d4c004122f37533c22a14c6ecb89b5da07011))
37+
38+
39+
### Bug Fixes
40+
41+
* **apigateway:** authorizerUri does not resolve to the correct partition ([#8152](https://github.com/aws/aws-cdk/issues/8152)) ([f455273](https://github.com/aws/aws-cdk/commit/f4552733909cd0734a7d829a35d0c1277b2ca4fc)), closes [#8098](https://github.com/aws/aws-cdk/issues/8098)
42+
* **apigateway:** methodArn not replacing path parameters with asterisks ([#8206](https://github.com/aws/aws-cdk/issues/8206)) ([8fc3751](https://github.com/aws/aws-cdk/commit/8fc37513477f4d9a8a37e4b6979a79e8ba6a1efd)), closes [#8036](https://github.com/aws/aws-cdk/issues/8036)
43+
* **aws-s3-deployment:** Set proper s-maxage Cache Control header ([#8434](https://github.com/aws/aws-cdk/issues/8434)) ([8d5b801](https://github.com/aws/aws-cdk/commit/8d5b801971ddaba82e0767c74fe7640d3e802c2f)), closes [#6292](https://github.com/aws/aws-cdk/issues/6292)
44+
* **cognito:** error when using parameter for `domainPrefix` ([#8399](https://github.com/aws/aws-cdk/issues/8399)) ([681b3bb](https://github.com/aws/aws-cdk/commit/681b3bbc7de517c06ac0bd848b73cc6d7267dfa1)), closes [#8314](https://github.com/aws/aws-cdk/issues/8314)
45+
* **dynamodb:** old global table replicas cannot be deleted ([#8224](https://github.com/aws/aws-cdk/issues/8224)) ([00884c7](https://github.com/aws/aws-cdk/commit/00884c752d6746864f2a71d093502d4fb2422037)), closes [#7189](https://github.com/aws/aws-cdk/issues/7189)
46+
* **elbv2:** addAction ignores conditions ([#8385](https://github.com/aws/aws-cdk/issues/8385)) ([729cc0b](https://github.com/aws/aws-cdk/commit/729cc0b1705cab64696682f21985d97ce6c41607)), closes [#8328](https://github.com/aws/aws-cdk/issues/8328)
47+
* **elbv2:** missing permission to write NLB access logs to S3 bucket ([#8114](https://github.com/aws/aws-cdk/issues/8114)) ([d6a1265](https://github.com/aws/aws-cdk/commit/d6a126508e4bb03f6f9d874c2c6648c3e3661a41)), closes [#8113](https://github.com/aws/aws-cdk/issues/8113)
48+
49+
## [1.44.0](https://github.com/aws/aws-cdk/compare/v1.43.0...v1.44.0) (2020-06-04)
50+
51+
52+
### Features
53+
54+
* **ecs-patterns:** support min and max health percentage in queueprocessingservice ([#8312](https://github.com/aws/aws-cdk/issues/8312)) ([6da564d](https://github.com/aws/aws-cdk/commit/6da564d68c5195c88c5959b7375e2973c2b07676))
55+
56+
## [1.43.0](https://github.com/aws/aws-cdk/compare/v1.42.1...v1.43.0) (2020-06-03)
57+
58+
59+
### ⚠ BREAKING CHANGES
60+
61+
* **rds:** the default retention policy for RDS Cluster and DbInstance is now 'Snapshot'
62+
* **cognito:** OAuth flows `authorizationCodeGrant` and
63+
`implicitCodeGrant` in `UserPoolClient` are enabled by default.
64+
* **cognito:** `callbackUrl` property in `UserPoolClient` is now
65+
optional and has a default.
66+
* **cognito:** All OAuth scopes in a `UserPoolClient` are now enabled
67+
by default.
68+
69+
### Features
70+
71+
* **cfn-include:** add support for Conditions ([#8144](https://github.com/aws/aws-cdk/issues/8144)) ([33212d2](https://github.com/aws/aws-cdk/commit/33212d2c3adfc5a06ec4557787aea1b3cd1e8143))
72+
* **cognito:** addDomain() on an imported user pool ([#8123](https://github.com/aws/aws-cdk/issues/8123)) ([49c9f99](https://github.com/aws/aws-cdk/commit/49c9f99c4dfd73bf53a461a844a1d9b0c02d3761))
73+
* **cognito:** sign in url for a UserPoolDomain ([#8155](https://github.com/aws/aws-cdk/issues/8155)) ([e942936](https://github.com/aws/aws-cdk/commit/e94293675b0a9ebeb5876283d6a54427391469bd))
74+
* **cognito:** user pool identity provider with support for Facebook & Amazon ([#8134](https://github.com/aws/aws-cdk/issues/8134)) ([1ad919f](https://github.com/aws/aws-cdk/commit/1ad919fecf7cda45293efc3c0805b2eb5b49ed69))
75+
* **dynamodb:** allow providing indexes when importing a Table ([#8245](https://github.com/aws/aws-cdk/issues/8245)) ([9ee61eb](https://github.com/aws/aws-cdk/commit/9ee61eb96de54fcbb71e41a2db2c1c9ec6b7b8d9)), closes [#6392](https://github.com/aws/aws-cdk/issues/6392)
76+
* **events-targets:** kinesis stream as event rule target ([#8176](https://github.com/aws/aws-cdk/issues/8176)) ([21ebc2d](https://github.com/aws/aws-cdk/commit/21ebc2dfdcc202bac47083d4c7d06e1ae4df0709)), closes [#2997](https://github.com/aws/aws-cdk/issues/2997)
77+
* **lambda-nodejs:** allow passing env vars to container ([#8169](https://github.com/aws/aws-cdk/issues/8169)) ([1755cf2](https://github.com/aws/aws-cdk/commit/1755cf274b4da446272f109b55b20680beb34fe7)), closes [#8031](https://github.com/aws/aws-cdk/issues/8031)
78+
* **rds:** change the default retention policy of Cluster and DB Instance to Snapshot ([#8023](https://github.com/aws/aws-cdk/issues/8023)) ([2d83328](https://github.com/aws/aws-cdk/commit/2d833280be7a8550ab4a713e7213f1dd351f9767)), closes [#3298](https://github.com/aws/aws-cdk/issues/3298)
79+
* **redshift:** add initial L2 Redshift construct ([#5730](https://github.com/aws/aws-cdk/issues/5730)) ([703f0fa](https://github.com/aws/aws-cdk/commit/703f0fa6e2ba5e668d6a92200493d19d2af626c0)), closes [#5711](https://github.com/aws/aws-cdk/issues/5711)
80+
* **s3:** supports RemovalPolicy for BucketPolicy ([#8158](https://github.com/aws/aws-cdk/issues/8158)) ([cb71f34](https://github.com/aws/aws-cdk/commit/cb71f340343011a2a2de9758879a56e898b8e12c)), closes [#7415](https://github.com/aws/aws-cdk/issues/7415)
81+
* **stepfunctions-tasks:** start a nested state machine execution as a construct ([#8178](https://github.com/aws/aws-cdk/issues/8178)) ([3000dd5](https://github.com/aws/aws-cdk/commit/3000dd58cbe05cc483e30da6c8b18e9e3bf27e0f))
82+
* **stepfunctions-tasks:** task state construct to submit a job to AWS Batch ([#8115](https://github.com/aws/aws-cdk/issues/8115)) ([bc41cd5](https://github.com/aws/aws-cdk/commit/bc41cd5662314202c9bd8af87587990ad0b50282))
83+
84+
85+
### Bug Fixes
86+
87+
* **apigateway:** deployment is not updated when OpenAPI definition is updated ([#8207](https://github.com/aws/aws-cdk/issues/8207)) ([d28c947](https://github.com/aws/aws-cdk/commit/d28c9473e0f480eba06e7dc9c260e4372501fc36)), closes [#8159](https://github.com/aws/aws-cdk/issues/8159)
88+
* **app-delivery:** could not use PipelineDeployStackAction more than once in a Stage ([#8217](https://github.com/aws/aws-cdk/issues/8217)) ([9a54447](https://github.com/aws/aws-cdk/commit/9a54447f2a7d7e3a5d31a57bb3b2e2b0555430a1)), closes [#3984](https://github.com/aws/aws-cdk/issues/3984) [#8183](https://github.com/aws/aws-cdk/issues/8183)
89+
* **cli:** termination protection not updated when change set has no changes ([#8275](https://github.com/aws/aws-cdk/issues/8275)) ([29d3145](https://github.com/aws/aws-cdk/commit/29d3145d1f4d7e17cd20f197d3c4955f48d07b37))
90+
* **codepipeline:** allow multiple CodeCommit source actions using events ([#8018](https://github.com/aws/aws-cdk/issues/8018)) ([103c144](https://github.com/aws/aws-cdk/commit/103c1449683ffc131b696faff8b16f0935a3c3f4)), closes [#7802](https://github.com/aws/aws-cdk/issues/7802)
91+
* **codepipeline:** correctly handle CODEBUILD_CLONE_REF in BitBucket source ([#7107](https://github.com/aws/aws-cdk/issues/7107)) ([ac001b8](https://github.com/aws/aws-cdk/commit/ac001b86bbff1801005cac1509e4480a30bf8f15))
92+
* **codepipeline:** unhelpful artifact validation messages ([#8256](https://github.com/aws/aws-cdk/issues/8256)) ([2a2406e](https://github.com/aws/aws-cdk/commit/2a2406e5cc16e3bcce4e355f54b31ca8a7c2ace6))
93+
* **core:** CFN version and description template sections were merged incorrectly ([#8251](https://github.com/aws/aws-cdk/issues/8251)) ([b7e328d](https://github.com/aws/aws-cdk/commit/b7e328da4e7720c27bd7e828ffe3d3ae9dc1d070)), closes [#8151](https://github.com/aws/aws-cdk/issues/8151)
94+
* **lambda:** `SingletonFunction.grantInvoke()` API fails with error 'No child with id' ([#8296](https://github.com/aws/aws-cdk/issues/8296)) ([a8b1815](https://github.com/aws/aws-cdk/commit/a8b1815f47b140b0fb06a3df0314c0fe28816fb6)), closes [#8240](https://github.com/aws/aws-cdk/issues/8240)
95+
* **rds:** cannot delete a stack with DbCluster set to 'Retain' ([#8110](https://github.com/aws/aws-cdk/issues/8110)) ([c2e534e](https://github.com/aws/aws-cdk/commit/c2e534ecab219be8cd8174b60da3b58072dcfd47)), closes [#5282](https://github.com/aws/aws-cdk/issues/5282)
96+
* **sqs:** unable to use CfnParameter 'valueAsNumber' to specify queue properties ([#8252](https://github.com/aws/aws-cdk/issues/8252)) ([8ec405f](https://github.com/aws/aws-cdk/commit/8ec405f5c016d0cbe1b9eeea6649e1e68f9b76e7)), closes [#7126](https://github.com/aws/aws-cdk/issues/7126)
97+
98+
## [1.42.1](https://github.com/aws/aws-cdk/compare/v1.42.0...v1.42.1) (2020-06-01)
99+
100+
101+
### Bug Fixes
102+
103+
* **lambda:** `SingletonFunction.grantInvoke()` API fails with error 'No child with id' ([#8296](https://github.com/aws/aws-cdk/issues/8296)) ([b4e264c](https://github.com/aws/aws-cdk/commit/b4e264c024bc58053412be1343bed6458628f7cb)), closes [#8240](https://github.com/aws/aws-cdk/issues/8240)
104+
5105
## [1.42.0](https://github.com/aws/aws-cdk/compare/v1.41.0...v1.42.0) (2020-05-27)
6106

7107

CONTRIBUTING.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ and let us know if it's not up-to-date (even better, submit a PR with your corr
4343
- [Troubleshooting](#troubleshooting)
4444
- [Debugging](#debugging)
4545
- [Connecting the VS Code Debugger](#connecting-the-vs-code-debugger)
46+
- [Run a CDK unit test in the debugger](#run-a-cdk-unit-test-in-the-debugger)
4647
- [Related Repositories](#related-repositories)
4748

4849
## Getting Started
@@ -183,6 +184,17 @@ Integration tests perform a few functions in the CDK code base -
183184
3. (Optionally) Acts as a way to validate that constructs set up the CloudFormation resources as expected. A successful
184185
CloudFormation deployment does not mean that the resources are set up correctly.
185186

187+
For Gitpod users only! The best way to supply CDK with your AWS credentials is to add them as
188+
[persisting environment variables](https://www.gitpod.io/docs/environment-variables).
189+
Adding them works as follows via terminal:
190+
191+
```shell
192+
eval $(gp env -e AWS_ACCESS_KEY_ID=XXXXXXXXX)
193+
eval $(gp env -e AWS_SECRET_ACCESS_KEY=YYYYYYY)
194+
eval $(gp env -e AWS_DEFAULT_REGION=ZZZZZZZZ)
195+
eval $(gp env -e)
196+
```
197+
186198
If you are working on a new feature that is using previously unused CloudFormation resource types, or involves
187199
configuring resource types across services, you need to write integration tests that use these resource types or
188200
features.
@@ -234,7 +246,7 @@ BREAKING CHANGE: Description of what broke and how to achieve this behavior now
234246
### Step 5: Pull Request
235247

236248
* Push to a GitHub fork or to a branch (naming convention: `<user>/<feature-bug-name>`)
237-
* Submit a Pull Requests on GitHub and assign the PR for a review to the "awslabs/aws-cdk" team.
249+
* Submit a Pull Request on GitHub. A reviewer will later be assigned by the maintainers.
238250
* Please follow the PR checklist written below. We trust our contributors to self-check, and this helps that process!
239251
* Discuss review comments and iterate until you get at least one “Approve”. When iterating, push new commits to the
240252
same branch. Usually all these are going to be squashed when you merge to master. The commit messages should be hints
@@ -327,7 +339,7 @@ All packages in the repo use a standard base configuration found at [eslintrc.js
327339
This can be customized for any package by modifying the `.eslintrc` file found at its root.
328340

329341
If you're using the VS Code and would like to see eslint violations on it, install the [eslint
330-
extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
342+
extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
331343

332344
#### pkglint
333345

@@ -910,6 +922,24 @@ To debug your CDK application along with the CDK repository,
910922
6. The debug view, should now have a launch configuration called 'Debug hello-cdk' and launching that will start the debugger.
911923
7. Any time you modify the CDK app or any of the CDK modules, they need to be re-built and depending on the change the `link-all.sh` script from step#2, may need to be re-run. Only then, would VS code recognize the change and potentially the breakpoint.
912924

925+
### Run a CDK unit test in the debugger
926+
927+
If you want to run the VSCode debugger on unit tests of the CDK project
928+
itself, do the following:
929+
930+
1. Set a breakpoint inside your unit test.
931+
2. In your terminal, depending on the type of test, run either:
932+
933+
```
934+
# (For tests names test.xxx.ts)
935+
$ node --inspect-brk /path/to/aws-cdk/node_modules/.bin/nodeunit -t 'TESTNAME'
936+
937+
# (For tests names xxxx.test.ts)
938+
$ node --inspect-brk /path/to/aws-cdk/node_modules/.bin/jest -i -t 'TESTNAME'
939+
```
940+
941+
3. On the `Run` pane of VSCode, select the run configuration **Attach to NodeJS** and click the button.
942+
913943
## Related Repositories
914944

915945
* [Samples](https://github.com/aws-samples/aws-cdk-examples): includes sample code in multiple languages

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ for tracking bugs and feature requests.
118118
* Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/aws-cdk)
119119
and tag it with `aws-cdk`
120120
* Come join the AWS CDK community on [Gitter](https://gitter.im/awslabs/aws-cdk)
121+
* Talk in the CDK channel of the [AWS Developers Slack workspace](https://awsdevelopers.slack.com) (invite required)
121122
* Open a support ticket with [AWS Support](https://console.aws.amazon.com/support/home#/)
122123
* If it turns out that you may have found a bug,
123124
please open an [issue](https://github.com/aws/aws-cdk/issues/new)

0 commit comments

Comments
 (0)