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

More documentation with samples in typescript

未关闭
#102 2 条评论 0 个 reaction 已指派 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 等服务客户端的命名和获取方式、VSCode 找不到已安装的 TypeScript 库的原因,以及需要哪些 handler;完成的标准是该指南通过可运行的示例回答这些问题。

由索引模型根据 Issue 内容生成。

评估

技术栈
aws, nodejs, typescript
领域
developer-experience, documentation
Issue 类型
文档
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。