@aws-lite/cloudformation

中文文档
0.1.3发布于 2024/08/02Apache-2.0ES Module零依赖近 30 天下载 8508

公务 aws-lite 云阵插件

中文使用文档
文档目录13 节
  1. 安装
  2. 参考文献
  3. 参考文献
  4. 方法
  5. CreateStack
  6. DeleteStack
  7. DescribeStackResources
  8. DescribeStacks
  9. ListStackResources
  10. UpdateStack
  11. UpdateTerminationProtection
  12. 有待执行的方法
  13. 学多点

@aws-lite/cloudformation

公务 aws-lite 云阵插件

由下列人员维护: @ architect

安装

npm i @aws-lite/cloudformation

可选安装类型 :

npm i -D @aws-lite/cloudformation-types

参考文献

在aws-lite.org提供实例参考文件

参考文献

在aws-lite.org提供实例参考文件

方法

CreateStack

Canonical AWS API API 文档

属性 :

  • StackName (弦) [须]
    • 堆栈名称或ID
  • Capabilities (阵列)
    • 堆栈创建所需的 CloudFormation 能力组合;可以是: CAPABILITY_IAM, (中文(简体) ), CAPABILITY_NAMED_IAM, (中文(简体) ), CAPABILITY_AUTO_EXPAND
  • ClientRequestToken (弦声)
    • 此请求的独特标识符; 从 1 - 128 b 匹配 [a-zA-Z0-9][-a-zA-Z0-9]*
  • DisableRollback (布尔)
    • 如果堆栈创建失败, 设置为真以禁用堆栈回滚
  • EnableTerminationProtection (布尔)
  • NotificationARNs (阵列)
    • SNS主题 ARNs 矩阵以发布堆栈相关活动
  • OnFailure (弦声)
    • 堆栈创建失败时要采取的行动;可以是: DO_NOTHING, (中文(简体) ), ROLLBACK, (中文(简体) ), DELETE
  • Parameters (阵列)
  • ResourceTypes (阵列)
  • RetainExceptOnCreate (布尔)
    • 设定为真以确保在操作回滚时将新创建的资源删除, 即使带有删除策略 Retain
  • RoleARN (弦声)
    • IAM 角色 ARN Cloud Formation 假设创建堆栈
  • RollbackConfiguration (标 题)
  • StackPolicyBody (字符串,对象)
    • 堆栈策略文档; 对象将被自动序列化为 JSON, 或提供预序列化的 JSON
    • 更详细情况( AWS)
  • StackPolicyURL (弦声)
    • 堆栈策略 URL
  • Tags (阵列)
  • TemplateBody (字符串,对象)
    • CloudFormation模板对象(会自动为您序列化为JSON),或预序列化的JSON或YAML;最多可达51,200 b
  • TemplateURL (弦声)
    • S3 Cloud Formation 模板的位置;最多可达 460 800 b
  • TimeoutInMinutes (数目)
    • 堆栈状态成为前的时间量 CREATE_FAILED

DeleteStack

Canonical AWS API API 文档

属性 :

  • StackName (弦) [须]
    • 堆栈名称或ID
  • ClientRequestToken (弦声)
    • 此请求的独特标识符; 从 1 - 128 b 匹配 [a-zA-Z0-9][-a-zA-Z0-9]*
  • RetainResources (阵列)
    • 删除堆栈后要保留的逻辑资源ID列表
  • RoleARN (弦声)
    • 删除时要承担的 IAM 角色 ARN

DescribeStackResources

Canonical AWS API API 文档

属性 :

  • StackName (弦声)
    • 堆栈名称或ID
  • LogicalResourceId (弦声)
    • 资源的逻辑名称
  • PhysicalResourceId (弦声)
    • 资源的实际名称或标识; 如果您未指定 PhysicalResourceId,必须指定 StackName

DescribeStacks

Canonical AWS API API 文档

属性 :

  • StackName (弦声)
    • 堆栈名称或ID
  • NextToken (弦声)
    • 如果 NextToken 先前的答复中退回
  • paginate (布尔,字符串)
    • 启用自动结果 pagination; 使用此选项, 而不是自制个人 pagination 请求

ListStackResources

Canonical AWS API API 文档

属性 :

  • StackName (弦) [须]
    • 堆栈名称或ID
  • NextToken (弦声)
    • 如果 NextToken 先前的答复中退回
  • paginate (布尔,字符串)
    • 启用自动结果 pagination; 使用此选项, 而不是自制个人 pagination 请求

UpdateStack

Canonical AWS API API 文档

属性 :

  • StackName (弦) [须]
    • 堆栈名称或ID
  • Capabilities (阵列)
    • 堆栈创建所需的 CloudFormation 能力组合;可以是: CAPABILITY_IAM, (中文(简体) ), CAPABILITY_NAMED_IAM, (中文(简体) ), CAPABILITY_AUTO_EXPAND
  • ClientRequestToken (弦声)
    • 此请求的独特标识符; 从 1 - 128 b 匹配 [a-zA-Z0-9][-a-zA-Z0-9]*
  • DisableRollback (布尔)
    • 如果堆栈创建失败, 设置为真以禁用堆栈回滚
  • NotificationARNs (阵列)
    • SNS主题 ARNs 矩阵以发布堆栈相关活动
  • Parameters (阵列)
  • ResourceTypes (阵列)
  • RetainExceptOnCreate (布尔)
    • 设定为真以确保在操作回滚时将新创建的资源删除, 即使带有删除策略 Retain
  • RoleARN (弦声)
    • IAM 角色 ARN Cloud Formation 假设创建堆栈
  • RollbackConfiguration (标 题)
  • StackPolicyBody (字符串,对象)
    • 堆栈策略文档; 对象将被自动序列化为 JSON, 或提供预序列化的 JSON
    • 更详细情况( AWS)
  • StackPolicyURL (弦声)
    • 堆栈策略 URL
  • Tags (阵列)
  • TemplateBody (字符串,对象)
    • CloudFormation模板对象(会自动为您序列化为JSON),或预序列化的JSON或YAML;最多可达51,200 b
  • TemplateURL (弦声)
    • S3 Cloud Formation 模板的位置;最多可达 460 800 b

UpdateTerminationProtection

Canonical AWS API API 文档

属性 :

  • StackName (弦) [须]
    • 堆栈名称或ID
  • EnableTerminationProtection [需要]
    • 在指定的堆栈上启用终止保护

有待执行的方法

请帮忙 打开 PR来啊!

学多点

版本与发布记录

@aws-lite/cloudformation 共发布 10 个版本,首次发布于 2023/12/24;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.3latest2024/08/022 年前
0.1.22024/08/012 年前
0.1.12024/08/012 年前
0.1.02024/05/282 年前
0.0.52024/04/272 年前
0.0.42024/02/072 年前

关于 @aws-lite/cloudformation 的常见问题

@aws-lite/cloudformation 是什么?

公务 aws-lite 云阵插件

如何安装 @aws-lite/cloudformation?

在项目目录运行 npm install @aws-lite/cloudformation,或使用 pnpm add / yarn add / bun add。

@aws-lite/cloudformation 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/aws-lite__cloudformation 是否存在。

@aws-lite/cloudformation 支持 ESM 还是 CommonJS?

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

@aws-lite/cloudformation 需要什么版本的 Node.js?

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

@aws-lite/cloudformation 可以商用吗?

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

@aws-lite/cloudformation 的下载量有多少?

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

@aws-lite/cloudformation 还在维护吗?

最新版本 0.1.3 发布于 2024/08/02(2 年前);至今共发布 10 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/12/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。