@aws-cdk/aws-dynamodb

中文文档
1.204.0发布于 2023/06/20Apache-2.0TypeScriptCommonJS近 30 天下载 11.1万

AWS: DynamoDB 的 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

中文使用文档
文档目录9 节
  1. 导入已存在的表格
  2. 密钥
  3. 计费模式
  4. 表格类别
  5. 配置表格的自动缩放
  6. 亚马逊迪纳摩DB 全球表
  7. 加密
  8. 获取表格或二级索引的策略
  9. Kinesis 流线

亚马逊 DynamoDB 构造库


End-of-Support

AWS CDK v1在2023-06-01上达到了支持结束. 此软件包不再更新,用户应该迁移到 AWS CDK v2.

关于如何移徙的更多信息,请参见: 移动到 AWS CDK v2 指南。 。 。 .


以下是最低可部署的DynamomDB表格定义:

const table = new dynamodb.Table(this, 'Table', {
  partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
});

导入已存在的表格

要将已有的表格导入您的 CDK 应用程序, 请使用 Table.fromTableName, (中文(简体) ), Table.fromTableArn 或者说 Table.fromTableAttributes 工厂方法。 这种方法接受表格名称或表格 ARN 描述一个已经存在的属性 现有表格 :

declare const user: iam.User;
const table = dynamodb.Table.fromTableArn(this, 'ImportedTable', 'arn:aws:dynamodb:us-east-1:111111111:table/my-table');
// now you can just call methods on the table
table.grantReadWriteData(user);

如果你打算使用 tableStreamArn (包括间接地,例如通过建立 @aws-cdk/aws-lambda-event-source.DynamoEventSource 在导入的表格上),您 必须 使用该 Table.fromTableAttributes 方法和 tableStreamArn 属性 必须 人口密集.

密钥

当表格被定义时,您必须使用 partitionKey (所需)和 sortKey (可选)属性.

计费模式

DynamoDB支持两种计费模式:

  • Provided - 表格和全球二级索引配置读写能力的默认模式.
  • PAY PER REQENT-按需定价和规模. 您只支付您使用的东西, 没有读写功能 .
const table = new dynamodb.Table(this, 'Table', {
  partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
  billingMode: dynamodb.BillingMode.PAY_PER_REQUEST,
});

进一步读作: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/How ItWorks. ReadWrite CapacityMode 互联网档案馆的存檔,存档日期2013-12-20。 。 。 .

表格类别

DynamoDB支持两个表类:

  • 标准(Standard)——默认模式,被推荐为绝大多数工作量.
  • STAND INFQUENT ACESS - 对存储为主要成本的表格进行优化.
const table = new dynamodb.Table(this, 'Table', {
  partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
  tableClass: dynamodb.TableClass.STANDARD_INFREQUENT_ACCESS,
});

进一步读作: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/How ItWorks.tableClasses.html 互联网档案馆的存檔,存档日期2014-12-21

配置表格的自动缩放

你可以让DynamomDB自动提高和降低读写能力 设置自动缩放。 你可以用这个 要么留着你的 表格的预期利用率,或通过在预配置时扩大或缩小 时间:

自动缩放仅与具有计费模式的表格相关,PROVISIONED.

配置自动缩放示例

进一步读作: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html 互联网档案馆的存檔,存档日期2014-12-21 https://aws.amazon.com/blogs/database/how-to-use-aws-cloudform-to-conform-auto-scale- for-amazon-dinamodb-tables-and-indexs/ 互联网档案馆的存檔,存档日期2014-12-02

亚马逊迪纳摩DB 全球表

您可以通过设置 DynamoDB 全球表格创建 replicationRegions a. 财产 Table数字 :

const globalTable = new dynamodb.Table(this, 'Table', {
  partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
  replicationRegions: ['us-east-1', 'us-east-2', 'us-west-2'],
});

在这样做时, 堆栈将添加一个 CloudFormation 自定义资源, 以便创建复制表格 选定区域.

Global Tables 的默认计费模式是 PAY_PER_REQUEST。 。 。 . 如果你想使用的话 PROVISIONED, (中文(简体) ), 您必须确保该表启用自动缩放:

const globalTable = new dynamodb.Table(this, 'Table', {
  partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
  replicationRegions: ['us-east-1', 'us-east-2', 'us-west-2'],
  billingMode: dynamodb.BillingMode.PROVISIONED,
});

globalTable.autoScaleWriteCapacity({
  minCapacity: 1,
  maxCapacity: 10,
}).scaleOnUtilization({ targetUtilizationPercent: 75 });

当为大表添加复制区域时,您可能想要增加 复制操作的超时 :

const globalTable = new dynamodb.Table(this, 'Table', {
  partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
  replicationRegions: ['us-east-1', 'us-east-2', 'us-west-2'],
  replicationTimeout: Duration.hours(2), // defaults to Duration.minutes(30)
});

加密

所有存储在亚马逊DynamoDB的用户数据在休息时全部加密. 在创建新表格时,您可以选择使用下列客户主密钥(CMK)加密您的表格:

  • AWS自有的CMK - 默认情况下,所有表格都会被加密到DynamoDB服务账户中的AWS自有客户主密钥(CMK)下(不适用额外收费).
  • AWS管理的CMK - AWS KMS密钥(每个区域一个)由AWS DynamoDB(应用AWS KMS收费)在您的账户中创建,管理并代表您使用.
  • 客户管理的 CMK - 您完全控制用于加密 DynamoDB 表的 KMS 密钥( 应用 AWS KMS 收费) .

用客户管理的 CMK 创建一个加密的表格 :

const table = new dynamodb.Table(this, 'MyTable', {
  partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
  encryption: dynamodb.TableEncryption.CUSTOMER_MANAGED,
});

// You can access the CMK that was added to the stack on your behalf by the Table construct via:
const tableEncryptionKey = table.encryptionKey;

您也可以提供自己的钥匙 :

import * as kms from '@aws-cdk/aws-kms';

const encryptionKey = new kms.Key(this, 'Key', {
  enableKeyRotation: true,
});
const table = new dynamodb.Table(this, 'MyTable', {
  partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
  encryption: dynamodb.TableEncryption.CUSTOMER_MANAGED,
  encryptionKey, // This will be exposed as table.encryptionKey
});

为了取而代之使用AWS管理的CMK,将代码改为:

const table = new dynamodb.Table(this, 'MyTable', {
  partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
  encryption: dynamodb.TableEncryption.AWS_MANAGED,
});

// In this case, the CMK _cannot_ be accessed through table.encryptionKey.

获取表格或二级索引的策略

要获得表格或索引的分区密钥和排序密钥,您已配置 :

declare const table: dynamodb.Table;
const schema = table.schema();
const partitionKey = schema.partitionKey;
const sortKey = schema.sortKey;

// In case you want to get schema details for any secondary index
// const { partitionKey, sortKey } = table.schema(INDEX_NAME);

Kinesis 流线

一个Kinesis Data Stream可以在DynamoDB表中被配置,以捕捉项目级别的变化.

import * as kinesis from '@aws-cdk/aws-kinesis';

const stream = new kinesis.Stream(this, 'Stream');

const table = new dynamodb.Table(this, 'Table', {
  partitionKey: { name: 'id', type: dynamodb.AttributeType.STRING },
  kinesisStream: stream,
});

版本与发布记录

@aws-cdk/aws-dynamodb 共发布 288 个版本,首次发布于 2018/07/31;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.204.0latest2023/06/203 年前
1.203.02023/06/013 年前
1.202.02023/05/223 年前
1.201.02023/05/113 年前
1.200.02023/04/273 年前
1.199.02023/04/213 年前

关于 @aws-cdk/aws-dynamodb 的常见问题

@aws-cdk/aws-dynamodb 是什么?

AWS: DynamoDB 的 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-dynamodb?

在项目目录运行 npm install @aws-cdk/aws-dynamodb,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@aws-cdk/aws-applicationautoscaling(1.204.0)、@aws-cdk/aws-cloudwatch(1.204.0)、@aws-cdk/aws-iam(1.204.0)、@aws-cdk/aws-kinesis(1.204.0)、@aws-cdk/aws-kms(1.204.0)、@aws-cdk/aws-lambda(1.204.0)、@aws-cdk/core(1.204.0)、@aws-cdk/custom-resources(1.204.0)、constructs(^3.3.69)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@aws-cdk/aws-dynamodb 支持 TypeScript 吗?

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

@aws-cdk/aws-dynamodb 支持 ESM 还是 CommonJS?

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

@aws-cdk/aws-dynamodb 需要什么版本的 Node.js?

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

@aws-cdk/aws-dynamodb 可以商用吗?

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

@aws-cdk/aws-dynamodb 的下载量有多少?

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

@aws-cdk/aws-dynamodb 还在维护吗?

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