# @digitalmaas/serverless-plugin-lambda-dead-letter 中文文档

规范地址：https://npmcn.com/package/%40digitalmaas/serverless-plugin-lambda-dead-letter/

版本：1\.0\.0
npm 元数据更新时间：2023-02-24T03:50:25.405Z
中文译文更新时间：2026-11-12T10:32:52.162Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40digitalmaas/serverless-plugin-lambda-dead-letter
原文对照：https://npmcn.com/package/%40digitalmaas/serverless-plugin-lambda-dead-letter/?lang=original
项目主页：https://github.com/digitalmaas/serverless-plugin-lambda-dead-letter#readme
源码仓库：https://github.com/digitalmaas/serverless-plugin-lambda-dead-letter

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：22.4 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=4\.0
- 运行依赖：2 个
- 首次发布：2023-02-24T03:50:25.032Z
- 最新版本发布：2023-02-24T03:50:25.276Z
- 近 30 天下载量：2555（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

无服务器的插件, 可以用死信队列或主题配置 lambda

## 安装

```sh
npm install @digitalmaas/serverless-plugin-lambda-dead-letter
```

也可以使用：`pnpm add @digitalmaas/serverless-plugin-lambda-dead-letter`、`yarn add @digitalmaas/serverless-plugin-lambda-dead-letter`、`bun add @digitalmaas/serverless-plugin-lambda-dead-letter`

## README

# 无服务器的 Lambda 死字队列插件

[![serverless](https://img.shields.io/badge/serverless-%E2%9A%A1-yellow.svg?colorB=555555&style=flat-square)](http://www.serverless.com/) [![NPM version](https://img.shields.io/npm/v/@digitalmaas/serverless-plugin-lambda-dead-letter.svg?style=flat-square)](https://www.npmjs.com/package/@digitalmaas/serverless-plugin-lambda-dead-letter) [![digitalmaas](https://img.shields.io/badge/sponsored%20by-digitalmaas-green.svg?colorB=00CD98&style=flat-square)](https://digitalmaas.com/) [![NPM downloads](https://img.shields.io/npm/dm/@digitalmaas/serverless-plugin-lambda-dead-letter.svg?style=flat-square)](https://www.npmjs.com/package/@digitalmaas/serverless-plugin-lambda-dead-letter) [![standardjs](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square)](https://standardjs.com/)

> A 类 [无服务器](http://www.serverless.com/) 插件,可以将一个死字 SQS 队列指定给 Lambda 函数 。 与无服务器的v1.4+,v2和v3一起工作.

## 这是什么?

指定 a `DeadLetterConfig` 到 Lambda 函数,并可选地创建一个新的 SQS 队列或 SNS Topic,并使用简单的语法.

Amazon Lambda 的同步消息失败, 可以通过设置 SQS 队列或 SNS 主题发送到 `DeadLetterConfig`. Lambda 死信队列 [此处记录](http://docs.aws.amazon.com/lambda/latest/dg/dlq.html)。 。 。 .

在开发此插件时, AWS Cloudform (和无服务器) 不支持 `DeadLetterConfig` lambda 的属性 所以我们引入了一个调用插件 `UpdateFunctionConfiguration` 在无服务器部署 Cloud Formation 堆栈后,在羊肉上.

## 安装

从目标无服务器项目中运行 :

```bash
npm install @digitalmaas/serverless-plugin-lambda-dead-letter --save-dev
```

## 基本设置

将插件添加到您的 `serverless.yml`数字 :

```yaml
plugins:
  - '@digitalmaas/serverless-plugin-lambda-dead-letter'
```

## 我该怎么用?

死信设置通过新程序指定 `deadLetter` 在函数下嵌入的属性 `serverless.yml` 文档.

有几种方法可以配置Lambda deadLetterConfig.

-   [方法 - 方法 1个](https://npmcn.com/package/%40digitalmaas/serverless-plugin-lambda-dead-letter/#readme-method-1): 创建新的死信 SQS 队列或 SNS 主题
-   [方法-2](https://npmcn.com/package/%40digitalmaas/serverless-plugin-lambda-dead-letter/#readme-method-2): 使用先前存在的队列/专题.
-   [方法 3](https://npmcn.com/package/%40digitalmaas/serverless-plugin-lambda-dead-letter/#readme-method-3): 使用资源中创建的队列/主题.
-   [删除已死信件资源](https://npmcn.com/package/%40digitalmaas/serverless-plugin-lambda-dead-letter/#readme-remove-deadletter-resource): 删除先前指定的任何死字队列/专题.

### 方法 - 方法 1个

#### 死信队列

使用 `deadLetter.sqs` 以创建函数的新死字队列.

由此产生的云形堆栈会包含一个 SQS 队列,并且是相应的队列政策.

#### 按名称创建新死字队列

```YAML
# 'functions' in serverless.yml

functions:
  createUser: # Function name
    handler: handler.createUser # Reference to function 'createUser' in code
    deadLetter:
      sqs:  createUser-dl-queue  # New Queue with this name
```

#### 新建带有属性的死字母队列

```YAML
# 'functions' in serverless.yml

functions:
  createUser: # Function name
    handler: handler.createUser # Reference to function 'createUser' in code
    deadLetter:
      sqs:      # New Queue with these properties
        queueName: createUser-dl-queue
        delaySeconds: 60
        maximumMessageSize: 2048
        messageRetentionPeriod: 200000
        receiveMessageWaitTimeSeconds: 15
        visibilityTimeout: 300
```

#### 死信主题

使用 `deadLetter.sns` 以创建函数的新死字题.

由此产生的云形堆栈将包含一个SQS主题资源.

```YAML
# 'functions' in serverless.yml

functions:
  createUser: # Function name
    handler: handler.createUser # Reference to function 'createUser' in code

    deadLetter:
      sns:  createUser-dl-topic
```

### 方法-2

使用 `targetArn` 属性以指定用于 Lambda 死信消息的 SQS 队列或 SNS 主题 。 在这种情况下,队列\\主题必须已经存在,队列\\主题政策也必须存在.

引用已有队列的 ARN `createUser-dl-queue`

```YAML
# 'functions' in serverless.yml

functions:
  createUser: # Function name
    handler: handler.createUser # Reference to function 'createUser' in code

    deadLetter:
      targetArn: arn:aws:sqs:us-west-2:123456789012:createUser-dl-queue
```

### 方法 3

如果您创建了队列\\ title `resource` 您可以使用 `GetResourceArn` 伪道.

这将使用引用资源的背景 `{logicalId}`

```YAML
    deadLetter:
      targetArn:
        GetResourceArn: {logicalId}
```

说明:

-   目前这只适用于SQS队列或SNS主题.
-   如果队列\\ title 创建于 `resources` 区域中您仍需要为相应的队列\\ title 策略添加资源,以使 lambda 有权限写入已死信件队列\\ title .

在这个例子中 `createUser` lambda 函数正在使用新的 `CreateUserDeadLetterQueue` 在资源一节中定义的 SQS 队列 .

```YAML
# 'functions' in serverless.yml

functions:
  createUser: # Function name

    handler: handler.createUser # Reference to function 'createUser' in code

    # ...

    deadLetter:
      targetArn:
        GetResourceArn: CreateUserDeadLetterQueue

resources:
    Resources:
      CreateUserDeadLetterQueue:
        Type: AWS::SQS::Queue
        Properties:
          QueueName: create-user-lambda-dl-queue

      CreateUserDeadLetterQueuePolicy:
        Type: AWS::SQS::QueuePolicy
        Properties:
          Queues:
            - Ref: CreateUserDeadLetterQueue

            # Policy properties abbreviated but you need more here ...
```

### 删除死信资源

如果您以前有一个"死信"目标,并且想要删除它,所以没有死信队列或话题,您可以提供 `deadLetter` 空白对象 `targetArn`。一旦部署插件将运行 Lambda `UpdateFunctionConfiguration` 并设定一个空的目标.

```YAML
# 'functions' in serverless.yml

functions:
  createUser: # Function name

    handler: handler.createUser # Reference to function 'createUser' in code

    # ...

    # Set an empty targetArn to erase previous DLQ settings.
    deadLetter:
      targetArn:
```

## 许可证

MIT许可证.

这个项目是原创的 [无服务器插件- lambda- dead- letter](https://github.com/gmetzker/serverless-plugin-lambda-dead-letter) 并用不同的名字出版,因为原作被废弃.

欲了解完整情况,请查阅 [许可证](https://npmcn.com/package/%40digitalmaas/serverless-plugin-lambda-dead-letter/LICENSE) 文档.

## 常见问题

### @digitalmaas/serverless-plugin-lambda-dead-letter 是什么？

无服务器的插件, 可以用死信队列或主题配置 lambda

### 如何安装 @digitalmaas/serverless-plugin-lambda-dead-letter？

在项目目录运行 npm install @digitalmaas/serverless-plugin-lambda-dead-letter，或使用 pnpm add / yarn add / bun add。

### @digitalmaas/serverless-plugin-lambda-dead-letter 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/digitalmaas\_\_serverless-plugin-lambda-dead-letter 是否存在。

### @digitalmaas/serverless-plugin-lambda-dead-letter 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @digitalmaas/serverless-plugin-lambda-dead-letter 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=4\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @digitalmaas/serverless-plugin-lambda-dead-letter 可以商用吗？

@digitalmaas/serverless-plugin-lambda-dead-letter 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @digitalmaas/serverless-plugin-lambda-dead-letter 的下载量有多少？

根据 npm 官方下载统计，@digitalmaas/serverless-plugin-lambda-dead-letter 在 2026/10/12 – 2026/11/10 这 30 天内被下载 2,555 次，日均约 85 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @digitalmaas/serverless-plugin-lambda-dead-letter 还在维护吗？

最新版本 1\.0\.0 发布于 2023/02/24（3 年前）；至今共发布 1 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/02/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

