Skip to content

Commit 1468a8c

Browse files
authored
Merge pull request #140 from digitalevidencetoolkit/claude/session-011CUa61zyTJTWLrLXjgWjvP
QLDB deprecation notice
2 parents 348a9ed + 5842795 commit 1468a8c

File tree

5 files changed

+25
-0
lines changed

5 files changed

+25
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
_(Or **DEPToolkit** for short. Bit of a mouthful otherwise)_
44

5+
> **⚠️ CRITICAL NOTICE**: This toolkit relies on AWS QLDB, which was deprecated by AWS and will be discontinued on **July 31, 2025**. The toolkit will require migration to an alternative ledger database solution.
6+
57
<div style="width:100%; display: flex; justify-content: center">
68
<img style="width: 70%" src="https://digitalevidencetoolkit.org/images/illustrations/architecture-full-curves.svg">
79
</div>

docs/getting_started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ If the instructions in this guide feel a bit much, it's likely because the Toolk
1111

1212
#### Setting up the ledger
1313

14+
> **⚠️ AWS QLDB DEPRECATION WARNING**: AWS QLDB is being discontinued on **July 31, 2025**. While you can still create QLDB ledgers for testing/development purposes, this toolkit will require migration to an alternative solution before that date. **Production use is not recommended.**
15+
1416
The Toolkit requires a working connection with Amazon Web Services, and thus that you have some kind of well-permissioned account or IAM role.
1517

1618
In short, you will need:

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
"license": "gpl-3.0",
1919
"dependencies": {
2020
"amazon-qldb-driver-nodejs": "^2.2.0",
21+
"_comment": "WARNING: AWS QLDB is deprecated and will be discontinued on July 31, 2025.",
2122
"aws-sdk": "^2.1354.0",
2223
"body-parser": "^1.20.3",
2324
"chalk": "^4.1.2",

src/ledger/index.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
/**
2+
* Ledger abstraction layer
3+
*
4+
* ⚠️ WARNING: AWS QLDB DEPRECATION NOTICE
5+
*
6+
* This module wraps AWS QLDB operations. Since QLDB is being discontinued on July 31, 2025,
7+
* this entire module will need to be refactored to work with an alternative ledger solution.
8+
*
9+
* @deprecated Depends on AWS QLDB which will be discontinued on July 31, 2025
10+
*/
11+
112
import * as Record from '../types/Record';
213
import * as Annotations from '../types/Annotations';
314
import type { Annotation } from '../types/Annotations';

src/qldb/index.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
/**
2+
* ⚠️ WARNING: AWS QLDB DEPRECATION NOTICE
3+
*
4+
* AWS QLDB is being discontinued on July 31, 2025.
5+
* This entire module will need to be replaced with an alternative ledger solution.
6+
*
7+
* @deprecated AWS QLDB service will be discontinued on July 31, 2025
8+
*/
9+
110
import {
211
QldbDriver,
312
Result,

0 commit comments

Comments
 (0)