# @effect-aws/ssm 中文文档

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

版本：2\.0\.0
npm 元数据更新时间：2026-10-02T14:21:14.132Z
中文译文更新时间：2026-11-13T08:10:19.683Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40effect-aws/ssm
原文对照：https://npmcn.com/package/%40effect-aws/ssm/?lang=original
项目主页：https://floydspace.github.io/effect-aws/docs/ssm
源码仓库：https://github.com/floydspace/effect-aws

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

- 包体积（解压后）：13 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：effect \>=4\.0\.0-beta\.66 \<5\.0\.0，@effect-aws/client-ssm ^2\.0\.0
- 首次发布：2024-09-07T16:51:32.571Z
- 最新版本发布：2026-10-02T14:21:13.603Z
- 近 30 天下载量：18661（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 11 个）

## 中文简介

有效的 AWS SSM 函数

## 安装

```sh
npm install @effect-aws/ssm
```

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

## README

# @ effect-aws/ sm (英语)

[![npm version](https://img.shields.io/npm/v/%40effect-aws%2Fssm?color=brightgreen&label=npm%20package)](https://www.npmjs.com/package/@effect-aws/ssm) [![npm downloads](https://img.shields.io/npm/dm/%40effect-aws%2Fssm)](https://www.npmjs.com/package/@effect-aws/ssm)

此软件包提供了 `fromParameterStore` [配置](https://effect.website/docs/guides/configuration) 构造函数 . 您可以用它从 AWS 系统管理器中读取参数 `Config` 计划.

配置原始名必须匹配参数名或参数存储中的ARN. 譬如说, `Config.String("my_parameter_name")` 或者说 `Config.String("arn:aws:ssm:eu-central-1:123456789012:parameter/my_parameter_name")`。 。 。 .

## 安装

```bash
npm install --save @effect-aws/ssm @effect-aws/client-ssm
```

## 使用量

默认服务层 :

```typescript
import { SSM } from "@effect-aws/client-ssm"
import { ConfigProvider } from "@effect-aws/ssm"
import { Effect, Config, Console } from "effect"

const program = Effect.gen(function* () {
  const param: string = yield* Config.String("my_parameter_name")

  yield* Console.log("Parameter from Parameter Store: ", param)
})

program.pipe(
  ConfigProvider.withParameterStoreConfigProvider(),
  Effect.provide(SSM.defaultLayer),
  Effect.runPromise
)
```

带有自定义服务层 :

```typescript
import { SSM } from "@effect-aws/client-ssm"
import { ConfigProvider } from "@effect-aws/ssm"
import { Config, Console, Effect } from "effect"

const program = Effect.gen(function* () {
  const param: string = yield* Config.String("my_parameter_name")

  yield* Console.log("Parameter from Parameter Store: ", param)
})

const serviceLayer = SSM.layer({ region: "eu-central-1" })

program.pipe(
  Effect.provide(ConfigProvider.setParameterStoreConfigProvider()),
  Effect.provide(serviceLayer),
  Effect.runPromise
)
```

## 常见问题

### @effect-aws/ssm 是什么？

有效的 AWS SSM 函数

### 如何安装 @effect-aws/ssm？

在项目目录运行 npm install @effect-aws/ssm，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：effect（\>=4\.0\.0-beta\.66 \<5\.0\.0）、@effect-aws/client-ssm（^2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @effect-aws/ssm 支持 TypeScript 吗？

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

### @effect-aws/ssm 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @effect-aws/ssm 可以商用吗？

@effect-aws/ssm 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @effect-aws/ssm 的下载量有多少？

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

### @effect-aws/ssm 还在维护吗？

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