# @aws-sdk/dsql-signer 中文文档

规范地址：https://npmcn.com/package/%40aws-sdk/dsql-signer/

版本：3\.1164\.0
npm 元数据更新时间：2026-11-06T20:14:57.383Z
中文译文更新时间：2026-11-07T10:30:37.327Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aws-sdk/dsql-signer
原文对照：https://npmcn.com/package/%40aws-sdk/dsql-signer/?lang=original
项目主页：https://github.com/aws/aws-sdk-js-v3/tree/main/packages/dsql-signer
源码仓库：https://github.com/aws/aws-sdk-js-v3

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

- 包体积（解压后）：26.2 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：6 个
- 首次发布：2024-12-03T19:58:54.200Z
- 最新版本发布：2026-11-06T20:14:57.178Z
- 近 30 天下载量：918112（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：324（近 12 个月 220 个）

## 中文简介

用于生成密码令牌的 Dsql 工具,可用于对 Dsql 数据库的 IAM 认证 .

## 安装

```sh
npm install @aws-sdk/dsql-signer
```

也可以使用：`pnpm add @aws-sdk/dsql-signer`、`yarn add @aws-sdk/dsql-signer`、`bun add @aws-sdk/dsql-signer`

## README

# @aws-sdk/dsql 签名器

[![NPM version](https://img.shields.io/npm/v/@aws-sdk/dsql-signer/latest.svg)](https://www.npmjs.com/package/@aws-sdk/dsql-signer) [![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/dsql-signer.svg)](https://www.npmjs.com/package/@aws-sdk/dsql-signer)

## 说明

这个软件包提供与Dsql互动的公用事业.

## 安装

```console
npm install @aws-sdk/dsql-signer
```

## 开始

### 导入

ES6 导入

```js
import { DsqlSigner } from "@aws-sdk/dsql-signer";
```

或者普通JS导入

```js
const { DsqlSigner } = require("@aws-sdk/dsql-signer");
```

### 生成 Dsql IAM 认证的证书

```js
import { Hash } from "@smithy/hash-node";
import { fromNodeProviderChain } from "@aws-sdk/credential-providers";

const signer = new DsqlSigner({
  /**
   * Required: The hostname of the database to connect to.
   */
  hostname: "foo0bar1baz2quux3quux4.dsql.us-east-1.on.aws",

  /**
   * Optional: The region the database is located in. Uses the region inferred from the runtime if omitted.
   */
  region: "us-east-1",

  /**
   * Optional: The SHA256 hasher constructor to sign the request.
   */
  sha256: Hash.bind(null, "sha256"),

  /**
   * Optional: The amount of time in seconds the generated token is valid
   */
  expiresIn: 3600,

  /**
   * Optional: The AWS credentials to sign requests with. Uses the default credential provider chain if not specified.
   * You can use any credential provider from https://www.npmjs.com/package/@aws-sdk/credential-providers,
   * or provide a credentials object.
   */
  credentials: fromNodeProviderChain(),
});

// Creates auth token.
const authToken = await signer.getDbConnectAuthToken();

// Creates admin auth token.
const adminAuthToken = await signer.getDbConnectAdminAuthToken();

// Use the token as the password for connecting to your Dsql instance.
```

## 常见问题

### @aws-sdk/dsql-signer 是什么？

用于生成密码令牌的 Dsql 工具,可用于对 Dsql 数据库的 IAM 认证 \.

### 如何安装 @aws-sdk/dsql-signer？

在项目目录运行 npm install @aws-sdk/dsql-signer，或使用 pnpm add / yarn add / bun add。

### @aws-sdk/dsql-signer 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aws-sdk/dsql-signer 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @aws-sdk/dsql-signer 需要什么版本的 Node\.js？

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

### @aws-sdk/dsql-signer 可以商用吗？

@aws-sdk/dsql-signer 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @aws-sdk/dsql-signer 的下载量有多少？

根据 npm 官方下载统计，@aws-sdk/dsql-signer 在 2026/10/08 – 2026/11/06 这 30 天内被下载 918,112 次，日均约 30,604 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aws-sdk/dsql-signer 还在维护吗？

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