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

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

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

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

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

- 包体积（解压后）：402 kB，20 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 14\.15\.0
- 运行依赖：2 个
- peer 依赖：@aws-cdk/core 1\.204\.0，constructs ^3\.3\.69
- 首次发布：2020-11-17T12:00:08.412Z
- 最新版本发布：2023-06-19T21:05:13.583Z
- 近 30 天下载量：2498（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：150（近 12 个月 0 个）

## 中文简介

AWS::IVS 的 CDK 构造库

## 安装

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

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

## README

# AWS::IVS 构造库

* * *

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

* * *

Amazon Interactive Video Service(亚马逊语:Amazon IVS)是一款有管理的直播流媒体 快速和易于设定的解决方案,以及创建互动 视频体验. 使用流媒体软件将活流发送到 Amazon IVS 服务会做所有你需要做的 低频视频 可供全世界任何观众使用,让你专注于建筑 互动体验与现场视频. 你可以轻松地定制和 通过亚马逊 IVS 播放器 SDK 和定时增强观众体验 元数据 APIs,允许您与您建立更有价值的关系 自己网站和应用程序上的观众.

这个模块是 [AWS 云开发套件](https://github.com/aws/aws-cdk) 项目.

## 频道

Amazon IVS 频道存储与您的直播相关的配置信息 流线。 您先创建一个频道,然后使用该频道提供视频 频道启动活流的流键 .

您可以创建频道

```ts
const myChannel = new ivs.Channel(this, 'Channel');
```

### 导入已有频道

例如,如果需要创建一个 现有频道的流键

```ts
const myChannel = ivs.Channel.fromChannelArn(this, 'Channel', myChannelArn);
```

## 流键

流键被广播编码器用于启动流并识别 到亚马逊IVS 客户和频道的溪流。 如果你是的话 存储此值,应视同密码.

您可以为给定频道创建流密钥

```ts
const myStreamKey = myChannel.addStreamKey('StreamKey');
```

## 私人频道

Amazon IVS提供了创建私人频道的能力,允许 您可以通过频道或查看器限制您的溪流。 您控制访问 通过允许在频道上播放播放授权来播放视频 生成已签名的 JSON Web Tokens (JWTs) 用于授权的回放请求.

回放符号是您所签名的 JWT (带有回放授权密钥) ,并在每一次播放中包含对有播放功能的频道的请求 授权已启用 .

为了让Amazon IVS 验证此符号, 您需要上传 用于签名的私人密钥.

```ts
const keyPair = new ivs.PlaybackKeyPair(this, 'PlaybackKeyPair', {
  publicKeyMaterial: myPublicKeyPemString,
});
```

然后在创建频道时指定授权属性

```ts
const myChannel = new ivs.Channel(this, 'Channel', {
  authorized: true, // default value is false
});
```

## 常见问题

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

AWS::IVS 的 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-ivs？

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

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

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

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

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

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

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

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

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

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

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

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

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