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

More documentation with samples in typescript

Đang mở
#102 2 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
TypeScript
Star
46
Fork
18
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Xem lại hướng dẫn liên kết về resource-type của AWS CloudFormation và ví dụ init bằng TypeScript sử dụng SessionProxy. Xác minh cách đặt tên và lấy các service client như DynamoDB, lý do thư viện TypeScript đã cài đặt không được VSCode tìm thấy, và những handler nào là bắt buộc; hoàn thành có nghĩa là hướng dẫn trả lời được các câu hỏi này bằng các mẫu hoạt động.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
aws, nodejs, typescript
Lĩnh vực
developer-experience, documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.