@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
开发工作流程(仅限服务器应用模板)
本节仅在下列情况下相关: 无服务器应用程序模板 寄存器,用于维护此软件包.
-
地方发展:
- 在无服务器应用模板开发过程中, 使用
@serverless-app/cdk-aspects用于当地测试 - 导入语句遵循模式 :
import { TableSettingsAspect, TagsAspect, addAspects } from '@serverless-app/cdk-aspects';
- 在无服务器应用模板开发过程中, 使用
-
生产用途:
- 无服务器应用- 模板的拖曳进程将自动 :
- 要使用的更新依赖性
@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');
});
});
许可证
麻省理工学院
捐款
此软件包在 无服务器应用程序模板 仓库.