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
feat(amplify): Add resource support (wip) #3209
Conversation
@eladb I think this is about done – mind reviewing it again? |
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.
Reviewed only app.ts but I believe many comments apply across the board. Let's do another iteration after you apply them throughout...
Also:
- Missing README
- All inline documentation is lacking. Preferably, copy & paste from the official AWS documentation with as much details as possible. Your goal is for people not to need to leave the IDE
Hey @sthulb, it would be nice to support the property (needs an update of the CFN specs). AWS Amplify Console adds support for automatically deploying branches that match a specific pattern |
@jogold Indeed – I plan on supporting it in another PR. I want to get this one merged and then I'll start on the new features |
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.
inline docs are still lacking. Make sure all public APIs (incl. arguments) are fully documented.
This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project. | ||
Define a new App: | ||
```ts | ||
new App(this, 'MyApp', { |
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.
use amplify.App
. This is the idiomatic way we reference resources within construct library modules and also we want to disambiguate with core.App
, which we idiomatically refer to as App
.
@@ -15,8 +15,79 @@ | |||
--- | |||
<!--END STABILITY BANNER--> | |||
|
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.
Provide some background about what is the Amplify service and what is this library capable of doing. As much as possible copy details and links from AWS documentation.
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.
The Amplify service (known as the Amplify Console) offers continuous deployment and fully managed hosting for fullstack serverless web apps.
@@ -15,8 +15,79 @@ | |||
--- | |||
<!--END STABILITY BANNER--> | |||
|
|||
This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project. | |||
Define a new App: |
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.
Explain what an amplify app is. assume throughout this doc that people don't need to open 100 browser tabs to understand what they need to do. This should be as self-contained as possible.
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.
An Amplify App is a collection of branches that represent frontend and backend environments.
@sthulb is this still under development? |
Yep. I’m on holiday at the moment. |
@sthulb is this still under development? |
sort of, it's on my to-do list of things. |
Thanks so much for taking the time to contribute to the AWS CDK ❤️ We will shortly assign someone to review this pull request and help get it
|
Start of the Amplify CDK L2 construct
fixes issue: #3207