# @aws-cdk/aws-neptune 中文文档

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

版本：1\.204\.0
npm 元数据更新时间：2023-11-21T10:16:26.391Z
中文译文更新时间：2026-11-07T17:40:42.854Z
软件包许可：Apache-2\.0

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

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

弃用说明：AWS CDK v1 has reached End-of-Support on 2023-06-01\. This package is no longer being updated, and users should migrate to AWS CDK v2\. For more information on how to migrate, see https://docs\.aws\.amazon\.com/cdk/v2/guide/migrating-v2\.html

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

- 包体积（解压后）：871 kB，26 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 14\.15\.0
- 运行依赖：5 个
- peer 依赖：@aws-cdk/aws-ec2 1\.204\.0，@aws-cdk/aws-iam 1\.204\.0，@aws-cdk/aws-kms 1\.204\.0，@aws-cdk/core 1\.204\.0，constructs ^3\.3\.69
- 首次发布：2018-07-31T13:38:11.922Z
- 最新版本发布：2023-06-19T21:07:01.040Z
- 近 30 天下载量：3617（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：288（近 12 个月 0 个）

## 中文简介

AWS: Neptune 的 CDK 构造库

## 安装

```sh
npm install @aws-cdk/aws-neptune
```

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

## README

# 亚马逊海王星构造库

* * *

![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)

> AWS CDK v1在2023-06-01上达到了支持结束. 此软件包不再更新,用户应该迁移到 AWS CDK v2.
> 
> 关于如何移徙的更多信息,请参见: [_移动到 AWS CDK v2_ 指南](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html)。 。 。 .

* * *

亚马逊 Neptune是一个快速,可靠,完全管理的图数据库服务,它使得与高度连接的数据集一起工作的应用程序易于构建和运行. 海王星的核心是一个目的建造的高性能图数据库引擎. 此引擎被优化,用于存储数十亿个关系,并用毫秒的耐用来查询图. Neptune支持流行的图查询语言Apache TinkerPop Gremlin和W3C的SPARQL,使您能够构建能高效地导航高连接数据集的查询.

这个 `@aws-cdk/aws-neptune` 软件包包含用于建立海王星数据库集群和实例的原始数据.

```ts
import * as neptune from '@aws-cdk/aws-neptune';
```

## 启动海王星数据库

为了建立海王星数据库,定义 `DatabaseCluster`您必须在 VPC 中启动数据库 .

```ts
const cluster = new neptune.DatabaseCluster(this, 'Database', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
});
```

默认情况下, 只能提供写家实例 .

## 连接中

要控制谁可以访问集群,请使用 `.connections` 属性。 海王星数据库有一个默认的端口,所以 您不需要指定端口 :

```ts
cluster.connections.allowDefaultPortFromAnyIpv4('Open to the world');
```

访问您数据库集群的终点将作为 `.clusterEndpoint` 财务报告和审定财务报表 `.clusterReadEndpoint` 属性 :

```ts
const writeAddress = cluster.clusterEndpoint.socketAddress;   // "HOSTNAME:PORT"
```

## IAM 认证

也可以使用 AWS 身份和访问管理(IAM) 数据库认证认证到数据库集群; 见 [https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth.html 互联网档案馆的存檔,存档日期2013-12-22](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth.html) 需要更多信息和所支持的列表 版本和限制.

以下例子显示可以对数据库集群进行IAM认证,并允许连接访问IAM角色.

```ts
const cluster = new neptune.DatabaseCluster(this, 'Cluster', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  iamAuthentication: true, // Optional - will be automatically set if you call grantConnect().
});
const role = new iam.Role(this, 'DBRole', { assumedBy: new iam.AccountPrincipal(this.account) });
cluster.grantConnect(role); // Grant the role connection access to the DB.
```

## 自定义参数

Neptune允许通过提供自定义参数组来配置数据库行为. 详情请参见: 以下链接 : [https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html 页面存档备份,存于互联网档案馆](https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html)

```ts
const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {
  description: 'Cluster parameter group',
  parameters: {
    neptune_enable_audit_log: '1'
  },
});

const dbParams = new neptune.ParameterGroup(this, 'DbParams', {
  description: 'Db parameter group',
  parameters: {
    neptune_query_timeout: '120000',
  },
});

const cluster = new neptune.DatabaseCluster(this, 'Database', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  clusterParameterGroup: clusterParams,
  parameterGroup: dbParams,
});
```

## 添加复制品

`DatabaseCluster` 允许与作者实例一起发射复制件。 可用 `instanceCount` 属性.

```ts
const cluster = new neptune.DatabaseCluster(this, 'Database', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  instances: 2,
});
```

此外,还可能增加使用 `DatabaseInstance` 用于一个已存在的集群.

```ts
const replica1 = new neptune.DatabaseInstance(this, 'Instance', {
  cluster,
  instanceType: neptune.InstanceType.R5_LARGE,
});
```

## 自动小版本升级

通过设置 `autoMinorVersionUpgrade` 到真, 海王星会自动更新 将整个集群的引擎稳定到最近一个小版本 窗口2至3周.

```ts
new neptune.DatabaseCluster(this, 'Cluster', {
  vpc,
  instanceType: neptune.InstanceType.R5_LARGE,
  autoMinorVersionUpgrade: true,
});
```

## 常见问题

### @aws-cdk/aws-neptune 是什么？

AWS: Neptune 的 CDK 构造库注意：该包已被作者标记为弃用——AWS CDK v1 has reached End-of-Support on 2023-06-01\. This package is no longer being updated, and users should migrate to AWS CDK v2\. For more information on how to migrate, see https://docs\.aws\.amazon\.com/cdk/v2/guide/migrating-v2\.html

### 如何安装 @aws-cdk/aws-neptune？

在项目目录运行 npm install @aws-cdk/aws-neptune，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@aws-cdk/aws-ec2（1\.204\.0）、@aws-cdk/aws-iam（1\.204\.0）、@aws-cdk/aws-kms（1\.204\.0）、@aws-cdk/core（1\.204\.0）、constructs（^3\.3\.69）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aws-cdk/aws-neptune 支持 TypeScript 吗？

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

### @aws-cdk/aws-neptune 支持 ESM 还是 CommonJS？

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

### @aws-cdk/aws-neptune 需要什么版本的 Node\.js？

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

### @aws-cdk/aws-neptune 可以商用吗？

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

### @aws-cdk/aws-neptune 的下载量有多少？

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

### @aws-cdk/aws-neptune 还在维护吗？

最新版本 1\.204\.0 发布于 2023/06/20（3 年前）；至今共发布 288 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/07/31。作者已将其标记为弃用，新项目建议寻找替代方案。