# @aws-cdk/cli-plugin-contract 中文文档

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

版本：2\.182\.2
npm 元数据更新时间：2026-04-16T15:28:48.668Z
中文译文更新时间：2026-11-07T09:28:25.328Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aws-cdk/cli-plugin-contract
原文对照：https://npmcn.com/package/%40aws-cdk/cli-plugin-contract/?lang=original
项目主页：https://github.com/aws/aws-cdk
源码仓库：https://github.com/aws/aws-cdk-cli

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

- 包体积（解压后）：32.5 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18\.0\.0
- 运行依赖：0 个
- 首次发布：2025-01-04T11:44:32.365Z
- 最新版本发布：2026-04-16T15:28:48.364Z
- 近 30 天下载量：1043311（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 3 个）

## 中文简介

CLI 和认证插件之间的合同,用于交换 AWS 证书

## 安装

```sh
npm install @aws-cdk/cli-plugin-contract
```

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

## README

# AWS CDK CLI 库

* * *

![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)

* * *

## 概览

作为任何与 AWS 账户交互的软件, CDK CLI 需要 AWS认证和授权证书. 当涉及到选择 获得证书的来源 页:1 [与 AWS CLI 相同的行为](https://npmcn.com/package/%40aws-cdk/cli-plugin-contract/\(https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-authentication.html\))但这种基本行为可能会导致 在一些失败情况下:

-   无法获得与之合作的首批全权证书.
-   初始全权证书所属的账户无法获取.
-   与全权证书有关的账户不同于 cLI试图运行.

由于这些失败可能因有效使用而发生,CDK CLI提议 用户提供AWS证书的替代机制:证书 提供者插件.

此套件定义了 CLI 和插件之间的类型和合同 , 的插件作者需要遵守.

入境点通过下列途径向国家劳工局通报: `--plugin` 命令行 参数。 此参数的值应该是 JavaScript 文件, 当 `require`"d,将返回一个实例 `Plugin` 接口.

一旦CLI获得插件实例,它首先初始化插件由 呼唤 `Plugin.init()` 方法,如果定义了。 CLI 使用这种方法 通过一个实例: `IPluginHost` 到插件处。 这个 插件反过来可以使用寄存器注册一个或多个实例 `CredentialProviderSource`,这是提供 证书已找到.

如果在认证过程中, CLI 决定使用插件, 它会尝试 每一个证书提供者源,按注册顺序排列。 对于 每个源头,第一个CLI会检查的是源头是否准备好 完全通过呼叫 `isAvailable()` 方法。 如果有,下一个检查是它能否提供证书 具体账户,CLI在当时的目标。 这是 `canProvideCredentials()` 方法.

如果两张支票都通过,CLI通过拨打来询问来源的证书 `getProvider()`除账户ID外,这种方法还收到 `Mode` 行动,可以是 `ForReading` 或者说 `ForWriting`。这些信息 可能有助于为使用个案设计证书。 例如,如果 CLI 只需要读取证书, 插件可以返回证书 拥有更多限制权限.

## 常见问题

### @aws-cdk/cli-plugin-contract 是什么？

CLI 和认证插件之间的合同,用于交换 AWS 证书

### 如何安装 @aws-cdk/cli-plugin-contract？

在项目目录运行 npm install @aws-cdk/cli-plugin-contract，或使用 pnpm add / yarn add / bun add。

### @aws-cdk/cli-plugin-contract 支持 TypeScript 吗？

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

### @aws-cdk/cli-plugin-contract 支持 ESM 还是 CommonJS？

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

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

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

### @aws-cdk/cli-plugin-contract 可以商用吗？

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

### @aws-cdk/cli-plugin-contract 的下载量有多少？

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

### @aws-cdk/cli-plugin-contract 还在维护吗？

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