# @cloudsnorkel/cdk-rds-sanitized-snapshots 中文文档

规范地址：https://npmcn.com/package/%40cloudsnorkel/cdk-rds-sanitized-snapshots/

版本：0\.1\.6
npm 元数据更新时间：2026-02-02T16:01:16.515Z
中文译文更新时间：2026-11-10T03:23:37.667Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40cloudsnorkel/cdk-rds-sanitized-snapshots
原文对照：https://npmcn.com/package/%40cloudsnorkel/cdk-rds-sanitized-snapshots/?lang=original
项目主页：https://github.com/CloudSnorkel/cdk-rds-sanitized-snapshots#readme
源码仓库：https://github.com/CloudSnorkel/cdk-rds-sanitized-snapshots

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

- 包体积（解压后）：417 kB，39 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：aws-cdk-lib ^2\.146\.0，constructs ^10\.0\.5
- 首次发布：2022-07-10T20:08:34.698Z
- 最新版本发布：2026-02-02T16:01:16.103Z
- 近 30 天下载量：5845（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 1 个）

## 中文简介

CDK 构造以定期取取 RDS 数据库的快照,将其消毒,并与所选账户共享.

## 安装

```sh
npm install @cloudsnorkel/cdk-rds-sanitized-snapshots
```

也可以使用：`pnpm add @cloudsnorkel/cdk-rds-sanitized-snapshots`、`yarn add @cloudsnorkel/cdk-rds-sanitized-snapshots`、`bun add @cloudsnorkel/cdk-rds-sanitized-snapshots`

## README

# RDS 保密快照的 CDK 构造

[![NPM](https://img.shields.io/npm/v/@cloudsnorkel/cdk-rds-sanitized-snapshots?label=npm&logo=npm)](https://www.npmjs.com/package/@cloudsnorkel/cdk-rds-sanitized-snapshots) [![PyPI](https://img.shields.io/pypi/v/cloudsnorkel.cdk-rds-sanitized-snapshots?label=pypi&logo=pypi)](https://pypi.org/project/cloudsnorkel.cdk-rds-sanitized-snapshots) [![Maven Central](https://img.shields.io/maven-central/v/com.cloudsnorkel/cdk.rds.sanitized-snapshots.svg?label=Maven%20Central&logo=java)](https://search.maven.org/search?q=g:%22com.cloudsnorkel%22%20AND%20a:%22cdk.rds.sanitized-snapshots%22) [![Go](https://img.shields.io/github/v/tag/CloudSnorkel/cdk-rds-sanitized-snapshots?color=red&label=go&logo=go)](https://pkg.go.dev/github.com/CloudSnorkel/cdk-rds-sanitized-snapshots-go/cloudsnorkelcdkrdssanitizedsnapshots) [![Nuget](https://img.shields.io/nuget/v/CloudSnorkel.Cdk.Rds.SanitizedSnapshots?color=red&&logo=nuget)](https://www.nuget.org/packages/CloudSnorkel.Cdk.Rds.SanitizedSnapshots/) [![Release](https://github.com/CloudSnorkel/cdk-rds-sanitized-snapshots/actions/workflows/release.yml/badge.svg)](https://github.com/CloudSnorkel/cdk-rds-sanitized-snapshots/actions/workflows/release.yml) [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/CloudSnorkel/cdk-rds-sanitized-snapshots/blob/main/LICENSE)

定期取用RDS数据库的快照,进行消毒,并与所选账户共享.

使用此软件实现您的开发和/或QA数据库创建自动化,而不是强迫它们使用一个数据库 去年创建的 被随机的善行所保持 开发者和QA 喜欢真实的数据和这个 允许您创建非生产数据库,并使用已消毒的生产数据。 使用消毒步骤删除密码, 取消信用卡号码,取消PII等.

见 [构造枢纽](https://constructs.dev/packages/@cloudsnorkel/cdk-rds-sanitized-snapshots/) 用于所有支持语言的安装指令和API.

## 概览

![Architecture diagram](https://npmcn.com/package/%40cloudsnorkel/cdk-rds-sanitized-snapshots/architecture.svg)

此工程提供一个 CDK 架构, 设置一个步骤函数和一个执行此函数的定时器 。 这个 函数将创建给定数据库的静态快照并共享配置的账户。 这些账户可以 然后从这些快照中创建新的数据库.

步骤函数可以通过以下方式创建快照:

1.  获取给定数据库的快照 :
    -   查找给定数据库的最新快照
    -   创建并等待新的快照
2.  提供 KMS 密钥后重新加密快照
3.  从快照创建临时数据库
4.  等待数据库准备好
5.  将临时数据库中的主密码重置为随机密码
6.  等待密码设置
7.  使用 Fargate 任务连接到临时数据库并运行已配置的 SQL 语句来消毒数据
8.  绘制临时数据库的快照
9.  可选择与其他账户共享快照( 如果您有开发者/ QA 的单独账户)
10.  删除临时数据库和快照

## 使用量

1.  确认您正在使用 CDK v2
2.  安装适当的软件包
    1.  [蟒](https://pypi.org/project/cloudsnorkel.cdk-rds-sanitized-snapshots)
        
        ```
        pip install cloudsnorkel.cdk-rds-sanitized-snapshots
        ```
        
    2.  [类型脚本或 Java 脚本](https://www.npmjs.com/package/@cloudsnorkel/cdk-rds-sanitized-snapshots)
        
        ```
        npm i @cloudsnorkel/cdk-rds-sanitized-snapshots
        ```
        
    3.  [爪哇语](https://search.maven.org/search?q=g:%22com.cloudsnorkel%22%20AND%20a:%22cdk.rds.sanitized-snapshots%22)
        
        ```xml
        <dependency>
        <groupId>com.cloudsnorkel</groupId>
        <artifactId>cdk.rds.sanitized-snapshots</artifactId>
        </dependency>
        ```
        
    4.  [走开](https://pkg.go.dev/github.com/CloudSnorkel/cdk-rds-sanitized-snapshots-go/cloudsnorkelcdkrdssanitizedsnapshots)
        
        ```
        go get github.com/CloudSnorkel/cdk-rds-sanitized-snapshots-go/cloudsnorkelcdkrdssanitizedsnapshots
        ```
        
    5.  [. NET 网络](https://www.nuget.org/packages/CloudSnorkel.Cdk.Rds.SanitizedSnapshots/)
        
        ```
        dotnet add package CloudSnorkel.Cdk.Rds.SanitizedSnapshots
        ```
        
3.  使用 `RdsSanitizedSnapshotter` 在代码中构造( 以默认参数开头是好的)

### 代码样本

```typescript
let vpc: ec2.Vpc;
let databaseInstance: rds.DatabaseInstance;

new RdsSanitizedSnapshotter(this, 'Snapshotter', {
  vpc: vpc,
  databaseInstance: databaseInstance,
  script: 'USE mydb; UPDATE users SET ssn = \'0000000000\'',
})
```

## 加密

新的快照将用原始数据库所用的同样密钥加密. 如果原始数据库不是 加密,快照也不会被加密. 要添加另一个改变密钥的步骤,请使用 KMS 密钥参数.

见 [AWS 文档](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ShareSnapshot.html) 说明 允许其他账户访问密钥.

## 解决问题

-   请检查access-date=中的日期值 (帮助) 状态机器状态检查步函数. 点击失败的步骤并检查输入, 输出 和例外.

## 测试

```
npm run bundle && npm run integ:default:deploy
```

## 常见问题

### @cloudsnorkel/cdk-rds-sanitized-snapshots 是什么？

CDK 构造以定期取取 RDS 数据库的快照,将其消毒,并与所选账户共享\.

### 如何安装 @cloudsnorkel/cdk-rds-sanitized-snapshots？

在项目目录运行 npm install @cloudsnorkel/cdk-rds-sanitized-snapshots，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：aws-cdk-lib（^2\.146\.0）、constructs（^10\.0\.5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cloudsnorkel/cdk-rds-sanitized-snapshots 支持 TypeScript 吗？

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

### @cloudsnorkel/cdk-rds-sanitized-snapshots 支持 ESM 还是 CommonJS？

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

### @cloudsnorkel/cdk-rds-sanitized-snapshots 可以商用吗？

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

### @cloudsnorkel/cdk-rds-sanitized-snapshots 的下载量有多少？

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

### @cloudsnorkel/cdk-rds-sanitized-snapshots 还在维护吗？

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

