aws-cloudformation / aws-cloudformation/cloudformation-cli-typescript-plugin

More documentation with samples in typescript

Open
#102 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
46
Forks
18
PR merge metrics
No merged PRs in 30d

Description

There's this [walkthrough](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-walkthrough.html) but it's using *java* as the language, and it's not very easy to understand.

From the documentation perspective, I don't understand how to call `dynamodb` from the handlers for example. It looks like I need to use the `SessionProxy`, but it's not documented how to get a hold of *dynamodb* aws client.
In the *init* example:
```
// Example:
try {
if (session instanceof SessionProxy) {
const client = session.client('S3');
}
```
1. Where's the documentation of which *string* should I pass in the `.client([string])` to get dynamodb, stepfunction (or others) clients?

2. Even after I run `npm install` to install the dependencies, VSCode still does not find `@amazon-web-services-cloudformation/cloudformation-cli-typescript-lib`

![image](https://user-images.githubusercontent.com/165290/223207562-8edf36ff-863d-4242-99fe-a7b3ea716c62.png)

3. Also, do I need to implement all "create, update, list, read..." operations? I was looking for to implement only *create*, *update* and *delete*.

Contributor guide

Open the contributing guide

Research direction

Review the linked AWS CloudFormation resource-type walkthrough and the TypeScript init example using SessionProxy. Verify how service clients such as DynamoDB are named and obtained, why the installed TypeScript library is not found by VSCode, and which handlers are required; done means the walkthrough answers these questions with working samples.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, nodejs, typescript
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.