Giter VIP home page Giter VIP logo

aws-cdk-guide's Introduction

Welcome to the AWS CDK Developer Guide

This is the GitHub repository for the AWS CDK Developer Guide. You're welcome to report issues with the documentation here or, if you have a moment, to submit a Pull Request with your suggested changes. PRs should target the main branch, not master, which has been deprecated.

  • v1 - contains the Markdown files for the CDK v1 Developer Guide
  • v2 - contains the Markdown files for the CDK v2 Developer Guide

Feel free to make a Pull Request against only one of these content sets (we'll make sure it gets into both).

Issues reported through the Feedback link at the bottom of the individual pages of the AWS CDK Developer Guide go to an internal Amazon issue tracker and may not appear here. However, we try to track most substantive AWS CDK Developer Guide work on GitHub so the community can see, comment, and contribute.

๐Ÿ“ NOTE - The Markdown files in this repository are an output of the AWS CDK Developer Guide build process, not the actual source files. Periodically, we update the Markdown files here from our builds. Changes may appear on docs.aws.amazon.com before they appear here.

Other Documentation Issues

Project Board

Have a look at the AWS CDK Developer Guide Project Board to see what we're working on at the moment. Note that items on the Wishlist may not be in any particular order. You can help us prioritize our work by +1'ing issues that are important to you.

Contributor Grant of License

By submitting a Pull Request against this repo, you grant Amazon the right to use use, modify, copy, and redistribute your contribution under any license we choose.

aws-cdk-guide's People

Contributors

arothian avatar cmckni3 avatar demus avatar doug-aws avatar evzzk avatar gaddam1987 avatar geremycohen avatar hacker65536 avatar iliapolo avatar jakeitegsy avatar justjulian avatar kaiz-io avatar okkarmin avatar orsenthil avatar psperber avatar raonitimo avatar rdbatch02 avatar ruivalim avatar s-kakol avatar sergiofgonzalez avatar shlo avatar simoncpu avatar simpleigh avatar sivarosh avatar stevejgordon avatar suhasgaddam-trueaccord avatar sunnyp1227 avatar tashbenbetov avatar yamatatsu avatar yaseenyounus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

aws-cdk-guide's Issues

Document how to display information from your app

Replaces this issue created by Doug-AWS on Feb 28 in the CDK repo: aws/aws-cdk#1908.

Original description:

Something like

sys.out("The S3 bucket name is " + myBucket.name

Feedback from user:

I found it difficult to discover how to add outputs to the stack (cdk.Output...), and then how to get the output values from the CDK CLI. I expected it to be part of the "Concepts" hierarchy, possibly something like "Passing out Data" to go along with "Passing in Data".

Create example of getting a reference to a resource by tag value

Replaces this issue created by Doug-AWS on Mar 11 in the CDK repo: aws/aws-cdk#1990.

Original description:

User wrote:

I'm trying to get a subnetId with a tag (actually the tag is applied by creation through CDK, so it's especially troublesome to not be able to find this).

In this example, you show how to apply a tag, but not how to find a resource with a Tag. Presently, I need to replace something like the following in the AWS SDK:

Filter filter = new Filter().withName("vpc-id").withValues(vpcId).withName("tag:Name").withValues("infraStack/CodeBuild VPC/PrivateSubnet1");

DescribeSubnetsRequest describeSubnetsRequest = new DescribeSubnetsRequest().withFilters(filter);

String subnetId = null;

try {
subnetId = getClient().describeSubnets(describeSubnetsRequest).getSubnets().iterator().next().getSubnetId();

Right now CDK doesn't necessarily have API or user guide documentation on how to do this--or I'm not finding it.

How to work around missing CDK features (overrides)

Replaces this issue created by ccfife on Apr 15 in the CDK repo: aws/aws-cdk#2294.

Original description:

This is a new topic for the how to section, and is largely covered "Accessing the AWS CloudFormation Layer" topic in the current guide. We just need to review the topic and make sure it is at the quality bar we want. We've learned that customers need to use the "escape hatch" to address specific use cases the L2 don't address yet.

Surface integration tests as samples

Replaces this issue created by eladb on Oct 9 in the CDK repo: aws/aws-cdk#883.

Original description:

We have many integration tests in our code base and most of them should be relevant as examples for how to use various features of the CDK. If only we added a bit of commentary, we could technically add them all as examples to our docs.

Review and refresh Concepts - Apps and Stacks section

Replaces this issue created by ccfife on Apr 15 in the CDK repo: aws/aws-cdk#2295.

Original description:

As we reorganize the Developer Guide we need to review each section in the order that we introduce them to customers to make sure they are complete and aren't introducing concepts that have not been defined yet.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.