@flipdish/cdk-aspects

中文文档
0.23.0发布于 2026/10/07MITTypeScriptES Module零依赖近 30 天下载 1970

Flipdish 无服务器应用程序的 CDK 方面

中文使用文档
文档目录9 节
  1. 安装
  2. 使用量
  3. 可用内容
  4. 标记外观
  5. 表格排列角度
  6. 开发工作流程(仅限服务器应用模板)
  7. 测试
  8. 许可证
  9. 捐款

@flipdish/cdk-ascouts (英语)

CDK Flipdish Serverless 应用程序,提供一致的 AWS 资源配置,并在我们的基础设施中标记.

安装

npm install @flipdish/cdk-aspects

使用量

该软件包提供了 CDK Developments ,可用于在您的 AWS 资源中执行一致的配置和标记. 导入和使用您的 SST 配置中的方块 :

import { TableSettingsAspect, TagsAspect, addAspects } from '@flipdish/cdk-aspects';

// In your SST config
export default {
  async stacks(app) {
    // Add standard aspects
    addAspects(app, [
      new TagsAspect(serviceName, datadogTeamName),
      new TableSettingsAspect(app.stage)
    ]);

    // ... rest of your stack configuration
  }
} as SSTConfig;

可用内容

标记外观

在您堆栈中的所有资源中应用一致的标记 。 这包括对资源组织和费用分配有用的服务名称和团队名称标签.

new TagsAspect(serviceName, teamName)

表格排列角度

在您的应用程序中执行一致的 DynamoDB 表格设置 。 这一方面确保:

  • PAY PER REQ 请购账单模式
  • 启用时间点恢复
  • 适当的分区键 (pk) 和排序键 (sk) 命名
  • 基于阶段的适当清除政策(为生产而保留,为发展而保留)
  • AWS 生产/整合阶段的每日备份快照,可配置计划:
    • warm (默认):仅温暖存储,1至30天(默认7)
    • warm-cold:为N天取暖,后为90天取冷(总N+90)
new TableSettingsAspect(stage) // warm, 7 days
new TableSettingsAspect(stage, { planType: 'warm', warmRetentionDays: 7 })
new TableSettingsAspect(stage, { planType: 'warm-cold', warmRetentionDays: 7 }) // 7 warm + 90 cold

开发工作流程(仅限服务器应用模板)

本节仅在下列情况下相关: 无服务器应用程序模板 寄存器,用于维护此软件包.

  1. 地方发展:

    • 在无服务器应用模板开发过程中, 使用 @serverless-app/cdk-aspects 用于当地测试
    • 导入语句遵循模式 :
      import { TableSettingsAspect, TagsAspect, addAspects } from '@serverless-app/cdk-aspects';
      
  2. 生产用途:

    • 无服务器应用- 模板的拖曳进程将自动 :
      • 要使用的更新依赖性 @flipdish/cdk-aspects
      • 相应替换导入语句
      • 删除本地内容包

对于所有其他项目,只需安装和导入 @flipdish/cdk-aspects 如上文安装和使用部分所示.

测试

您可以通过检查您的 CloudFormation 模板来验证这些方面是否工作正确 。 以下是使用 Jest/Vitest 的例子:

import { Template } from 'aws-cdk-lib/assertions';
import { App } from 'sst/constructs';

describe('DynamoDB checks', () => {
  it('All tables have billing mode PAY_PER_REQUEST', () => {
    template.allResourcesProperties('AWS::DynamoDB::Table', {
      BillingMode: 'PAY_PER_REQUEST',
    });
  });

  it('All tables have point in time recovery enabled', () => {
    template.allResourcesProperties('AWS::DynamoDB::Table', {
      PointInTimeRecoverySpecification: {
        PointInTimeRecoveryEnabled: true,
      },
    });
  });

  it('All tables should have RETAIN removal policy in production but DELETE in dev', () => {
    checkTableDeletionPolicy(template, 'Delete');
    checkTableDeletionPolicy(prodStageTemplate, 'Retain');
  });
});

许可证

麻省理工学院

捐款

此软件包在 无服务器应用程序模板 仓库.

版本与发布记录

@flipdish/cdk-aspects 共发布 39 个版本,首次发布于 2025/04/17;过去 12 个月发布了 17 个版本。

版本发布日期距今
0.23.0latest2026/10/071 个月前
0.22.02026/09/171 个月前
0.21.02026/08/272 个月前
0.20.02026/08/043 个月前
0.19.02026/07/213 个月前
0.18.02026/07/213 个月前

关于 @flipdish/cdk-aspects 的常见问题

@flipdish/cdk-aspects 是什么?

Flipdish 无服务器应用程序的 CDK 方面

如何安装 @flipdish/cdk-aspects?

在项目目录运行 npm install @flipdish/cdk-aspects,或使用 pnpm add / yarn add / bun add。

@flipdish/cdk-aspects 支持 TypeScript 吗?

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

@flipdish/cdk-aspects 支持 ESM 还是 CommonJS?

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

@flipdish/cdk-aspects 可以商用吗?

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

@flipdish/cdk-aspects 的下载量有多少?

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

@flipdish/cdk-aspects 还在维护吗?

最新版本 0.23.0 发布于 2026/10/07(1 个月前);至今共发布 39 个版本,其中过去 12 个月发布了 17 个;首次发布于 2025/04/17。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。