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

More documentation with samples in typescript

オープン
#102 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
TypeScript
スター
46
フォーク
18
PR マージ指標
30日以内にマージされた PR はありません

説明

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*.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

リンクされている AWS CloudFormation のリソースタイプに関する手順と、SessionProxy を使用した TypeScript の init 例を確認する。DynamoDB などのサービスクライアントの名前付け方法と取得方法、インストールされた TypeScript ライブラリが VSCode で見つからない理由、必要な handler を検証する。手順がこれらの疑問に動作するサンプルで答えていれば完了とする。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
aws, nodejs, typescript
領域
developer-experience, documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。