# @aws-cdk/service-spec-importers 中文文档

规范地址：https://npmcn.com/package/%40aws-cdk/service-spec-importers/

版本：0\.0\.145
npm 元数据更新时间：2026-10-21T02:37:18.072Z
中文译文更新时间：2026-11-07T14:45:05.523Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aws-cdk/service-spec-importers
原文对照：https://npmcn.com/package/%40aws-cdk/service-spec-importers/?lang=original
项目主页：https://github.com/cdklabs/awscdk-service-spec#readme
源码仓库：https://github.com/cdklabs/awscdk-service-spec

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

- 包体积（解压后）：1.1 MB，159 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：10 个
- 首次发布：2023-10-25T15:42:35.205Z
- 最新版本发布：2026-10-21T02:37:17.734Z
- 近 30 天下载量：15742（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：145（近 12 个月 53 个）

## 中文简介

将服务来源输入服务模式数据库

## 安装

```sh
npm install @aws-cdk/service-spec-importers
```

也可以使用：`pnpm add @aws-cdk/service-spec-importers`、`yarn add @aws-cdk/service-spec-importers`、`bun add @aws-cdk/service-spec-importers`

## README

# 服务 Spec 导入器

将各种服务规格来源导入服务数据库.

## 使用量

### 程序化

```ts
declare const db: SpecDatabase;

new DatabaseBuilder(db, options)
  // Import (modern) CloudFormation Registry Resources from a directory structure: <region>/<resource>.json
  .importCloudFormationRegistryResources('data/CloudFormationSchema/')

  // Import the (modern) JSON schema spec from SAM
  .importSamJsonSchema('data/sam.schema.json')

  // Import (legacy) CloudFormation Resource Specification from a directory structure containing a patch set: <region>/000_cloudformation/*.json
  .importCloudFormationResourceSpec('data/CloudFormationResourceSpecification/')

  // Import (legacy) SAM Resource Specification from a directory structure containing a patch set: *.json
  .importSamResourceSpec('data/SAMResourceSpecification/')

  // Import GetAtt'able attributes with the same name as properties
  .importGetAttAllowList('data/GetAttAllowlist/GetAttAllowlist.json')

  // Import various model enhancements
  .importCloudFormationDocs('data/CloudFormationDocumentation.json')
  .importStatefulResources('data/StatefulResources/StatefulResources.json')
  .importCannedMetrics('data/CloudWatchConsoleServiceDirectory.json'),

  // Apply the imports to the database
  .build();
```

### 国 际

```console
Usage: import-db [options] [database]

Import service specification sources into a service model database

Arguments:
  database                         The database file (default: "db.json")

Options:
  -s, --source <definition...>     Import sources into the database. Use the format <source>:<path> to define sources.
  -l, --load <database>            Load an existing database as base, imported sources become additive
  -c, --gzip                       Compress the database file using gzip
  -f, --force                      Force overwriting an existing file (default: false)
  -d, --debug                      Print additional debug output during import (default: false)
  -r, --report <report-directory>  Create a detailed build report in the specified directory
  -v, --validate                   Validate imported sources and fail if any data is invalid (default: false)
  -h, --help                       display help for command
```

## 来源

| CLI 源名称 | 数据库构建方法 | 路径参数 |
| --- | --- | --- |
| `cfnSchemaDir` | `importCloudFormationRegistryResources` | 结构目录 `<region>/<resource>.json` |
| `samSchema` | `importSamJsonSchema` | SAM 注册 Schema 文件 |
| `cfnSpecDir` | `importCloudFormationResourceSpec` | 包含补丁集的目录结构 `<region>/000_cloudformation/*.json` |
| `samSpec` | `importSamResourceSpec` | SAM 资源规格文件 |
| `cfnDocs` | `importCloudFormationDocs` | CloudFormation 文档文件 |
| `statefulResources` | `importStatefulResources` | 国有资源文件 |
| `cannedMetrics` | `importCannedMetrics` | CloudWatch Console 服务目录文件 |

### 云层排列记录Schema

CLI: 爱丽丝 `cfnSchemaDir`  
代码 : `importCloudFormationRegistryResources(schemaDir: string)`

从目录结构中导入(现代) Cloud Formation Register Resources. 目录 MUST 包含每个区域的目录,每个区域包含每个资源的登记计划文件.

```txt
CloudFormationSchema/
├─ us-east-1/
│  ├─ aws-s3-bucket.json
├─ eu-west-1/
│  ├─ aws-s3-bucket.json
```

### SAM 登记册Schema

CLI: 爱丽丝 `samSchema`  
代码 : `importSamJsonSchema(filePath: string)`

从 SAM 导入 (现代) JSON Schema Spec. 包含 SAM Register Schema 的单一文件路径 .

## 常见问题

### @aws-cdk/service-spec-importers 是什么？

将服务来源输入服务模式数据库

### 如何安装 @aws-cdk/service-spec-importers？

在项目目录运行 npm install @aws-cdk/service-spec-importers，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 diff-db、import-db、analyze-db，可以用 npx diff-db 直接运行。

### @aws-cdk/service-spec-importers 支持 TypeScript 吗？

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

### @aws-cdk/service-spec-importers 支持 ESM 还是 CommonJS？

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

### @aws-cdk/service-spec-importers 可以商用吗？

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

### @aws-cdk/service-spec-importers 的下载量有多少？

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

### @aws-cdk/service-spec-importers 还在维护吗？

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