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

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

版本：1\.204\.0
npm 元数据更新时间：2023-11-21T10:15:52.059Z
中文译文更新时间：2026-11-07T11:31:48.415Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aws-cdk/aws-kinesis
原文对照：https://npmcn.com/package/%40aws-cdk/aws-kinesis/?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 元数据）

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

## 中文简介

AWS: Kinesis 的 CDK 构造库

## 安装

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

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

## README

# 亚马逊 Kinesis 构造库

* * *

![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)。 。 。 .

* * *

[亚马逊 Kinesis](https://docs.aws.amazon.com/streams/latest/dev/introduction.html) 提供大型 [溪流](https://aws.amazon.com/streaming-data/) 实时数据记录。 Kinesis 数据流可用于快速和连续的数据 录取和汇总.

## 目录

-   [流线](https://npmcn.com/package/%40aws-cdk/aws-kinesis/#readme-streams)
    -   [加密](https://npmcn.com/package/%40aws-cdk/aws-kinesis/#readme-encryption)
    -   [导入](https://npmcn.com/package/%40aws-cdk/aws-kinesis/#readme-import)
    -   [许可赠款](https://npmcn.com/package/%40aws-cdk/aws-kinesis/#readme-permission-grants)
        -   [读取权限](https://npmcn.com/package/%40aws-cdk/aws-kinesis/#readme-read-permissions)
        -   [写入权限](https://npmcn.com/package/%40aws-cdk/aws-kinesis/#readme-write-permissions)
        -   [自定义权限](https://npmcn.com/package/%40aws-cdk/aws-kinesis/#readme-custom-permissions)
    -   [计量](https://npmcn.com/package/%40aws-cdk/aws-kinesis/#readme-metrics)

## 流线

Amazon Kinesis Data Streams实时地摄入了大量数据,长期存储数据,并使数据可供消费.

使用 CCDK ,可以使用构造器创建新的 Kinesis 流作为堆栈的一部分. 您可以指定 `streamName` 给予 您自己的标识符到流。 如果没有, Cloud Formation 将生成一个名称 .

```ts
new kinesis.Stream(this, 'MyFirstStream', {
  streamName: 'my-awesome-stream',
});
```

您也可以指定属性, 如 `shardCount` 以表示溪流应选择多少块和 `retentionPeriod` 以具体说明在硬盘中的数据应可持续多久. 更多信息 [创建和管理溪流](https://docs.aws.amazon.com/streams/latest/dev/working-with-streams.html)

```ts
new kinesis.Stream(this, 'MyFirstStream', {
  streamName: 'my-awesome-stream',
  shardCount: 3,
  retentionPeriod: Duration.hours(48),
});
```

### 加密

[串流加密](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-streamencryption.html) 启用 对指定的流使用 AWS KMS 密钥进行服务器侧加密.

默认情况下, 可以在您的流上使用 Kinesis Data Streams 所拥有的主密钥进行加密, 在支持该密钥的区域进行加密 .

```ts
new kinesis.Stream(this, 'MyEncryptedStream');
```

您可以通过指定 : `encryption` 属性. 将为您创建 KMS 密钥, 并与该流相关 .

```ts
new kinesis.Stream(this, 'MyEncryptedStream', {
  encryption: kinesis.StreamEncryption.KMS,
});
```

您也可以通过指定 : `encryptionKey` 属性.

```ts
const key = new kms.Key(this, 'MyKey');

new kinesis.Stream(this, 'MyEncryptedStream', {
  encryption: kinesis.StreamEncryption.KMS,
  encryptionKey: key,
});
```

### 导入

堆栈外已创建的任何 Kinesis 流可以导入到您的 CDK 应用程序 .

流能由它们的 ARN 通过 `Stream.fromStreamArn()` API 密码

```ts
const importedStream = kinesis.Stream.fromStreamArn(this, 'ImportedStream',
  'arn:aws:kinesis:us-east-2:123456789012:stream/f3j09j2230j',
);
```

加密流也可以通过其属性通过 `Stream.fromStreamAttributes()` API 密码

```ts
const importedStream = kinesis.Stream.fromStreamAttributes(this, 'ImportedEncryptedStream', {
  streamArn: 'arn:aws:kinesis:us-east-2:123456789012:stream/f3j09j2230j',
  encryptionKey: kms.Key.fromKeyArn(this, 'key',
    'arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012',
  ),
});
```

### 许可赠款

IAM角色,用户或团体在运行时需要能够与Amazon Kinesis流合作的,应当获得IAM许可.

执行 `IGrantable` 接口(有相关主机)可以通过调用:

-   `grantRead(principal)` - 允许本金阅读访问
-   `grantWrite(principal)` - 给予主要写作权限
-   `grantReadWrite(principal)` - 授予主读写权限

#### 读取权限

赠款 `read` 通过调用 `grantRead()` API (英语). 如果流有加密密钥,读取权限也会被授予密钥.

```ts
const lambdaRole = new iam.Role(this, 'Role', {
  assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),
  description: 'Example role...',
});

const stream = new kinesis.Stream(this, 'MyEncryptedStream', {
  encryption: kinesis.StreamEncryption.KMS,
});

// give lambda permissions to read stream
stream.grantRead(lambdaRole);
```

下列阅读权限由服务负责人提供: `grantRead()` API : (英语)

-   `kinesis:DescribeStreamSummary`
-   `kinesis:GetRecords`
-   `kinesis:GetShardIterator`
-   `kinesis:ListShards`
-   `kinesis:SubscribeToShard`

#### 写入权限

赠款 `write` 通过调用 `grantWrite()` API (英语). 如果流有加密密钥,写入权限也会被授予密钥.

```ts
const lambdaRole = new iam.Role(this, 'Role', {
  assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),
  description: 'Example role...',
});

const stream = new kinesis.Stream(this, 'MyEncryptedStream', {
  encryption: kinesis.StreamEncryption.KMS,
});

// give lambda permissions to write to stream
stream.grantWrite(lambdaRole);
```

下列写作权限由服务主管提供: `grantWrite()` API : (英语)

-   `kinesis:ListShards`
-   `kinesis:PutRecord`
-   `kinesis:PutRecords`

#### 自定义权限

您可以调用 : `grant()` API (英语).

```ts
const user = new iam.User(this, 'MyUser');

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

// give my user permissions to list shards
stream.grant(user, 'kinesis:ListShards');
```

### 计量

您可以使用您溪流中常见的度量衡来创建提醒和/或仪表板. 这个 `stream.metric('MetricName')` 方法创建带有流命名空间和维度的度量. 您也可以使用预定义方法,如 `stream.metricGetRecordsSuccess()`。了解更多关于 Kinesis 度量衡的检查 [使用 Amazon Cloud Watch 监测 Amazon Kinesis 数据流服务](https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html)。 。 。 .

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

// Using base metric method passing the metric name
stream.metric('GetRecords.Success');

// using pre-defined metric method
stream.metricGetRecordsSuccess();

// using pre-defined and overriding the statistic
stream.metricGetRecordsSuccess({ statistic: 'Maximum' });
```

## 常见问题

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

AWS: Kinesis 的 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-kinesis？

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

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

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

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

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

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

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

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

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

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

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

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

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