-
Notifications
You must be signed in to change notification settings - Fork 4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add pkglint rule to require the presence of a README.md file #442
Merged
Merged
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
0a7a29b
Add pkglint rule to require the presence of a README.md file
RomainMuller 8e2be0e
Some twaks to aws-cdk/README.md
RomainMuller 8283e97
Switch JSON block to use JS highlighter, so comments are handled prop…
RomainMuller feba50c
Switch shell examples to 'console' formatter
RomainMuller af015c3
Prefix comments with $ in shell sessions.
RomainMuller d3073e0
Table of contents for the commands
RomainMuller db63f01
Correct anchor
RomainMuller fa821c9
Move TOC before Commands heading
RomainMuller File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## AWS CDK applet host program for Javascript | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS API Gateway | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Application Auto-Scaling | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS AppSync | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Athena | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Auto-Scaling | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Auto-Scaling Plans | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Batch | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Budgets | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Cloud9 | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## CDK Constructs for AWS CloudFormation | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS CodeDeploy | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Cognito | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Config | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Data Pipeline | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Data Accelerator (DAX) | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Directory Service | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Database Migration Service (DMS) | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Elastic Container Registry (ECR) | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Elastic Container Service (ECS) | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Elastic File System (EFS) | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS EKS | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS ElastiCache | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Elastic Beanstalk | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## CDK Constructs for AWS Elastic Load Balancing (ELB) | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Elastic Load Balancing (V2) | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Elasticsearch | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Elastic MapReduce (EMR) | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS GameLift | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Glue | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS GuardDuty | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Inspector | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS IoT | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Kinesis Analytics | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Kinesis Firehose | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## CDK Constructs for AWS Neptune | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS OpsWorks | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## AWS Quickstarts for the CDK | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Redshift | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Simple Database | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for the AWS Serverless Application Model (SAM) | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Service Catalog | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Service Discovery | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Simple Email Service | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Systems Manager | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Step Functions | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Web Application Firewall | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## The CDK Construct Library for AWS Web Application Firewall (Regional) | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## AWS CDK Construct Library for AWS WorkSpaces | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## AWS Cloud Development Kit for Javascript | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## Utilities to diff AWS CDK stacks against CloudFormation templates | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## Cloud Executable protocol | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## Utility routines used for implementing AWS CDK libraries | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,175 @@ | ||
## AWS CDK Toolkit | ||
The AWS CDK Toolkit provides the `cdk` command-line interface that can be used to work with AWS CDK applications. | ||
|
||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. | ||
|
||
### Commands | ||
Command | Description | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Perfect. Obviously over-done ;-) |
||
----------------------------------|------------------------------------------------------------------------------------- | ||
[`cdk docs`](#cdk-docs) | Access the online documentation | ||
[`cdk init`](#cdk-init) | Start a new CDK project (app or library) | ||
[`cdk list`](#cdk-list) | List stacks in an application | ||
[`cdk synth`](#cdk-synthesize) | Synthesize a CDK app to CloudFormation template(s) | ||
[`cdk diff`](#cdk-diff) | Diff stacks against current state | ||
[`cdk deploy`](#cdk-deploy) | Deploy a stack into an AWS account | ||
[`cdk destroy`](#cdk-destroy) | Deletes a stack from an AWS account | ||
[`cdk bootstrap`](#cdk-bootstrap) | Deploy a toolkit stack to support deploying large stacks & artifacts | ||
[`cdk doctor`](#cdk-doctor) | Inspect the environment and produce information useful for troubleshooting | ||
|
||
|
||
#### `cdk docs` | ||
Outputs the URL to the documentation for the current toolkit version, and attempts to open a browser to that URL. | ||
|
||
```console | ||
$ # Open the documentation in the default browser (using 'open') | ||
$ cdk docs | ||
https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/ | ||
|
||
$ # Open the documentation in Chrome. | ||
$ cdk docs --browser='chrome %u' | ||
https://awslabs.github.io/aws-cdk/versions/0.7.4-beta/ | ||
``` | ||
|
||
#### `cdk init` | ||
Creates a new CDK project. | ||
|
||
```console | ||
$ # List the available template types & languages | ||
$ cdk init --list | ||
Available templates: | ||
* app: Template for a CDK Application | ||
└─ cdk init app --language=[java|typescript] | ||
* lib: Template for a CDK Construct Library | ||
└─ cdk init lib --language=typescript | ||
|
||
$ # Create a new library application in typescript | ||
$ cdk init lib --language=typescript | ||
``` | ||
|
||
#### `cdk list` | ||
Lists the stacks modeled in the CDK app. | ||
|
||
```console | ||
$ # List all stacks in the CDK app 'node bin/main.js' | ||
$ cdk list --app='node bin/main.js' | ||
Foo | ||
Bar | ||
Baz | ||
|
||
$ # List all stack including all details (add --json to output JSON instead of YAML) | ||
$ cdk list --app='node bin/main.js' --long | ||
- | ||
name: Foo | ||
environment: | ||
name: 000000000000/bermuda-triangle-1 | ||
account: '000000000000' | ||
region: bermuda-triangle-1 | ||
- | ||
name: Bar | ||
environment: | ||
name: 111111111111/bermuda-triangle-2 | ||
account: '111111111111' | ||
region: bermuda-triangle-2 | ||
- | ||
name: Baz | ||
environment: | ||
name: 333333333333/bermuda-triangle-3 | ||
account: '333333333333' | ||
region: bermuda-triangle-3 | ||
``` | ||
|
||
#### `cdk synthesize` | ||
Synthesize the CDK app and outputs CloudFormation templates. If the application contains multiple stacks and no | ||
stack name is provided in the command-line arguments, the `--output` option is mandatory and a CloudFormation template | ||
will be generated in the output folder for each stack. | ||
|
||
By default, templates are generated in YAML format. The `--json` option can be used to switch to JSON. | ||
|
||
```console | ||
$ # Generate the template for StackName and output it to STDOUT | ||
$ cdk synthesize --app='node bin/main.js' MyStackName | ||
|
||
$ # Generate the template for MyStackName and save it to template.yml | ||
$ cdk synth --app='node bin/main.js' MyStackName --output=template.yml | ||
|
||
$ # Generate templates for all the stacks and save them into templates/ | ||
$ cdk synth --app='node bin/main.js' --output=templates | ||
``` | ||
|
||
#### `cdk diff` | ||
Computes differences between the infrastructure specified in the current state of the CDK app and the currently | ||
deployed application (or a user-specified CloudFormation template). This command returns non-zero if any differences are | ||
found. | ||
|
||
```console | ||
$ # Diff against the currently deployed stack | ||
$ cdk diff --app='node bin/main.js' MyStackName | ||
|
||
$ # Diff against a specific template document | ||
$ cdk diff --app='node bin/main.js' MyStackName --template=path/to/template.yml | ||
``` | ||
|
||
#### `cdk deploy` | ||
Deploys a stack of your CDK app to it's environment. During the deployment, the toolkit will output progress | ||
indications, similar to what can be observed in the AWS CloudFormation Console. If the environment was never | ||
bootstrapped (using `cdk bootstrap`), only stacks that are not using assets and synthesize to a template that is under | ||
51,200 bytes will successfully deploy. | ||
|
||
```console | ||
$ cdk deploy --app='node bin/main.js' MyStackName | ||
``` | ||
|
||
#### `cdk destroy` | ||
Deletes a stack from it's environment. This will cause the resources in the stack to be destroyed (unless they were | ||
configured with a `DeletionPolicy` of `Retain`). During the stack destruction, the command will output progress | ||
information similar to what `cdk deploy` provides. | ||
|
||
```console | ||
$ cdk destroy --app='node bin/main.js' MyStackName | ||
``` | ||
|
||
#### `cdk bootstrap` | ||
Deploys a `CDKToolkit` CloudFormation stack into the specified environment(s), that provides an S3 bucket that | ||
`cdk deploy` will use to store synthesized templates and the related assets, before triggering a CloudFormation stack | ||
update. The name of the deployed stack can be configured using the `--toolkit-stack-name` argument. | ||
|
||
```console | ||
$ # Deploys to all environments | ||
$ cdk bootstrap --app='node bin/main.js' | ||
|
||
$ # Deploys only to environments foo and bar | ||
$ cdk bootstrap --app='node bin/main.js' foo bar | ||
``` | ||
|
||
#### `cdk doctor` | ||
Inspect the current command-line environment and configurations, and collect information that can be useful for | ||
troubleshooting problems. It is usually a good idea to include the information provided by this command when submitting | ||
a bug report. | ||
|
||
```console | ||
$ cdk doctor | ||
ℹ️ CDK Version: 0.7.4-beta (build 0191444) | ||
ℹ️ AWS environment variables: | ||
- AWS_EC2_METADATA_DISABLED = 1 | ||
- AWS_SDK_LOAD_CONFIG = 1 | ||
``` | ||
|
||
### Configuration | ||
On top of passing configuration through command-line arguments, it is possible to use JSON configuration files. The | ||
configuration's order of precedence is: | ||
1. Command-line arguments | ||
2. Project configuration (`./cdk.json`) | ||
3. User configuration (`~/.cdk.json`) | ||
|
||
#### JSON Configuration files | ||
Some of the interesting keys that can be used in the JSON configuration files: | ||
```js | ||
{ | ||
"app": "node bin/main.js", // Command to start the CDK app (--app='node bin/main.js') | ||
"context": { // Context entries (--context=key:value) | ||
"key": "value", | ||
}, | ||
"toolkitStackName": "foo", // Customize 'bootstrap' stack name (--toolkit-stack-name=foo) | ||
"versionReporting": false, // Opt-out of version reporting (--no-version-reporting) | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
## Tools for generating cross-package artifacts | ||
This module is part of the [AWS Cloud Development Kit](https://github.com/awslabs/aws-cdk) project. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure I understand your
1.
here -- but I agree with2.
(initially intended to, somehow lost it at some point -- already re-organized the sections).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
✅ I've tried something - I hope that's what you meant :)