# @aws-amplify/data-construct 中文文档 规范地址：https://npmcn.com/package/%40aws-amplify/data-construct/ 版本：1\.17\.9 npm 元数据更新时间：2026-11-06T16:03:23.713Z 中文译文更新时间：2026-11-07T09:11:31.129Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40aws-amplify/data-construct 原文对照：https://npmcn.com/package/%40aws-amplify/data-construct/?lang=original 项目主页：https://github.com/aws-amplify/amplify-category-api#readme 源码仓库：https://github.com/aws-amplify/amplify-category-api ## 关键信息（来自 npm 元数据） - 包体积（解压后）：123 MB，14566 个文件 - 模块格式：CommonJS - TypeScript 类型：包内自带 - 运行依赖：145 个 - peer 依赖：constructs ^10\.5\.0，aws-cdk-lib ^2\.224\.0 - 首次发布：2023-11-08T23:25:57.212Z - 最新版本发布：2026-11-06T16:03:23.477Z - 近 30 天下载量：615232（2026-10-07 至 2026-11-05，npm 官方下载统计） - 已发布版本数：148（近 12 个月 10 个） ## 中文简介 AppSync GraphQL Api 构造 使用 放大 GraphQL 变换器 - 异用 `Data` 名称方案. ## 安装 ```sh npm install @aws-amplify/data-construct ``` 也可以使用：`pnpm add @aws-amplify/data-construct`、`yarn add @aws-amplify/data-construct`、`bun add @aws-amplify/data-construct` ## README # 放大数据构造 [![View on Construct Hub](https://constructs.dev/badge?package=%40aws-amplify%2Fdata-construct)](https://constructs.dev/packages/@aws-amplify/data-construct) 此套件会 vend a L3 CDK Constructure 包裝了 Amplify GraphQL 变形器的行为. 这使得AppSync API能够快速开发并插入支持"放大图形QL指令". 关于GraphQL中计划模型的更多信息,请参见: [扩展开发者文件](https://docs.amplify.aws/cli/graphql/overview/)。 。 。 . 使用此构造的主要方式是用一个提供的 schema( 要么作为内置的图克字符串, 要么作为一个或多个) 引用它 `appsync.SchemaFile`(a) 物品,并附有授权配置。 AppSync API的授权有5个支持的方法,这些都由这个构造支持. 关于授权规则定义的更多信息,请参见: [授权文件](https://docs.amplify.aws/cli/graphql/authorization-rules/)注:目前至少需要一项授权规则,如果有多项授权,则需一项授权规则 `defaultAuthorizationMode` 必须在相片上指定。 指定的授权模式必须是在图克l schema中配置的这些模式的超级集. ## 实例 ### 以 Cognitto 用户池为基础的所有者授权的简单待办事宜列表 在这个例子中,我们创建一个单一的模型,它将使用 `user pool` 认证以允许用户登录以创建和管理自己的 `todos` 私下. 我们创建了 Cdk App 和 Stack, 尽管您可能正在将它应用到自定义的堆栈中, 这纯粹是一个简洁的演示. 然后,我们通过电线导入一个已经部署的用户库(例如,创建和部署已超出范围). ```ts import { App, Stack } from 'aws-cdk-lib'; import { UserPool } from 'aws-cdk-lib/aws-cognito'; import { AmplifyData, AmplifyDataDefinition } from '@aws-amplify/data-construct'; const app = new App(); const stack = new Stack(app, 'TodoStack'); new AmplifyData(stack, 'TodoApp', { definition: AmplifyDataDefinition.fromString(/* GraphQL */ ` type Todo @model @auth(rules: [{ allow: owner }]) { description: String! completed: Boolean } `), authorizationModes: { userPoolConfig: { userPool: UserPool.fromUserPoolId(stack, 'ImportedUserPool', ''), }, }, }); ``` ### 多个相关模式,可公开阅读访问,管理员阅读/写入访问 在这个例子中,我们创建了两个相关的模型,这些模型将在“Author”和“Admin”用户组的用户中登录 完全访问,使用 api 密钥请求的客户只能读取权限 . ```ts import { App, Stack } from 'aws-cdk-lib'; import { UserPool } from 'aws-cdk-lib/aws-cognito'; import { AmplifyData, AmplifyDataDefinition } from '@aws-amplify/data-construct'; const app = new App(); const stack = new Stack(app, 'BlogStack'); new AmplifyData(stack, 'BlogApp', { definition: AmplifyDataDefinition.fromString(/* GraphQL */ ` type Blog @model @auth(rules: [{ allow: public, operations: [read] }, { allow: groups, groups: ["Author", "Admin"] }]) { title: String! description: String posts: [Post] @hasMany } type Post @model @auth(rules: [{ allow: public, operations: [read] }, { allow: groups, groups: ["Author", "Admin"] }]) { title: String! content: [String] blog: Blog @belongsTo } `), authorizationModes: { defaultAuthorizationMode: 'API_KEY', apiKeyConfig: { description: 'Api Key for public access', expires: cdk.Duration.days(7), }, userPoolConfig: { userPool: UserPool.fromUserPoolId(stack, 'ImportedUserPool', ''), }, }, }); ``` ### 从文件导入 GraphQL Schema, 而不是内含 . 在这个例子中,我们从一个或多个本地文件中导入了 schema 定义本身,而不是内置的图克字符串. ```graphql # todo.graphql type Todo @model @auth(rules: [{ allow: owner }]) { content: String! done: Boolean } ``` ```graphql # blog.graphql type Blog @model @auth(rules: [{ allow: owner }, { allow: public, operations: [read] }]) { title: String! description: String posts: [Post] @hasMany } type Post @model @auth(rules: [{ allow: owner }, { allow: public, operations: [read] }]) { title: String! content: [String] blog: Blog @belongsTo } ``` ```ts // app.ts import { App, Stack } from 'aws-cdk-lib'; import { UserPool } from 'aws-cdk-lib/aws-cognito'; import { AmplifyData, AmplifyDataDefinition } from '@aws-amplify/data-construct'; const app = new App(); const stack = new Stack(app, 'MultiFileStack'); new AmplifyData(stack, 'MultiFileDefinition', { definition: AmplifyDataDefinition.fromFiles(path.join(__dirname, 'todo.graphql'), path.join(__dirname, 'blog.graphql')), authorizationModes: { defaultAuthorizationMode: 'API_KEY', apiKeyConfig: { description: 'Api Key for public access', expires: cdk.Duration.days(7), }, userPoolConfig: { userPool: UserPool.fromUserPoolId(stack, 'ImportedUserPool', ''), }, }, }); ``` ## 常见问题 ### @aws-amplify/data-construct 是什么？ AppSync GraphQL Api 构造 使用 放大 GraphQL 变换器 - 异用 Data 名称方案\. ### 如何安装 @aws-amplify/data-construct？ 在项目目录运行 npm install @aws-amplify/data-construct，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：constructs（^10\.5\.0）、aws-cdk-lib（^2\.224\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。 ### @aws-amplify/data-construct 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @aws-amplify/data-construct 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @aws-amplify/data-construct 可以商用吗？ @aws-amplify/data-construct 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @aws-amplify/data-construct 的下载量有多少？ 根据 npm 官方下载统计，@aws-amplify/data-construct 在 2026/10/07 – 2026/11/05 这 30 天内被下载 615,232 次，日均约 20,508 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @aws-amplify/data-construct 还在维护吗？ 最新版本 1\.17\.9 发布于 2026/11/07（1 天前）；至今共发布 148 个版本，其中过去 12 个月发布了 10 个；首次发布于 2023/11/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。