AWS Auto Remediate 项目使用说明

1. 目录结构及介绍

AWS Auto Remediate 项目是一个开源应用，用于通过 AWS Config 立即修复常见的安全问题。以下是项目的目录结构及其介绍：

aws-auto-remediate/
├── .github/              # GitHub 工作流和代码仓库配置文件
├── .vscode/              # Visual Studio Code 项目配置文件
├── auto_remediate/       # 自动修复相关代码和文件
├── auto_remediate_dlq/   # 死信队列相关处理代码
├── auto_remediate_setup/ # 自动修复设置相关代码
├── images/               # 项目相关图像文件
├── .gitignore            # Git 忽略文件列表
├── .travis.yml           # Travis CI 持续集成配置文件
├── CHANGELOG.md          # 项目更新日志
├── CODE_OF_CONDUCT.md    # 项目行为准则
├── CONTRIBUTING.md       # 贡献指南
├── COVERAGE.md           # 代码覆盖率信息
├── LICENSE               # 项目许可证信息
├── README.md             # 项目说明文件
├── package.json          # Node.js 项目配置文件
├── requirements.txt      # Python 项目依赖文件
├── serverless.yml        # Serverless Framework 配置文件

2. 项目的启动文件介绍

项目的启动主要通过 serverless.yml 文件进行配置。该文件定义了 Serverless Framework 部署 AWS Lambda 函数和其他相关资源所需的配置信息。以下是 serverless.yml 的基本结构：

service: aws-auto-remediate

provider:
  name: aws
  runtime: nodejs12.x
  iamRoleStatements:
    - Effect: Allow
      Action: logs:*
      Resource: "*"

functions:
  AutoRemediate:
    handler: auto_remediate.handler
    events:
      - sqs: auto-remediate-config-compliance

  AutoRemediateDLQ:
    handler: auto_remediate_dlq.handler
    events:
      - schedule: rate(5 minutes)

  AutoRemediateSetup:
    handler: auto_remediate_setup.handler

3. 项目的配置文件介绍

项目的配置主要通过 serverless.yml 文件中的 provider 和 functions 部分进行设置。

• provider 部分：定义了服务提供商的名称（AWS），运行时环境（Node.js 12.x），以及 IAM 角色的权限声明。
• functions 部分：定义了 Lambda 函数的名称、处理程序和触发事件。例如，AutoRemediate 函数通过 SQS 队列 auto-remediate-config-compliance 触发，AutoRemediateDLQ 函数通过定时器触发，而 AutoRemediateSetup 函数需要手动调用。

此外，项目还使用 requirements.txt 文件来定义 Python 项目的依赖，以及 package.json 文件来管理 Node.js 项目的依赖和脚本。