CodeBuild 配置参数详细信息和示例

您可以在模板中为 CodeBuild基于 AWS Proton 资源的定义参数，并在配置代码中引用这些参数。有关参数、参数类型、 AWS Proton 参数命名空间以及如何在 IaC 文件中使用参数的详细说明，请参阅AWS Proton 参数。

注意

您可以对环境和服务使用 CodeBuild 置备。目前，您无法通过这种方法预置组件。

输入参数

创建 AWS Proton 资源（如环境或服务）时，需要为模板架构文件中定义的输入参数提供值。当您创建的资源使用时CodeBuild 预置，会将这些输入值 AWS Proton 呈现到输入文件中。您的预置代码可以从该文件中导入和获取参数值。

有关 CodeBuild 模板的示例，请参见CodeBuild 配置模板包。有关清单文件的更多信息，请参阅总结模板文件 AWS Proton。

以下示例是在 CodeBuild基于服务实例的配置期间生成的 JSON 输入文件。

示例：使用 AWS CDK 带 CodeBuild 配置的

{
  "service_instance": {
    "name": "my-service-staging",
    "inputs": {
      "port": "8080",
      "task_size": "medium"
    }
  },
  "service": {
    "name": "my-service"
  },
  "environment": {
    "account_id": "123456789012",
    "name": "my-env-staging",
    "outputs": {
      "vpc-id": "hdh2323423"
    }
  }
}

输出参数

要将资源配置输出传回给 AWS Proton，您的配置代码可以生成一个名为的 JSON 文件，该文件名proton-outputs.json为模板架构文件中定义的输出参数的值。例如，该cdk deploy命令的--outputs-file参数指示生成包含配置输出的 AWS CDK JSON 文件。如果您的资源使用 AWS CDK，请在 CodeBuild 模板清单中指定以下命令：

aws proton notify-resource-deployment-status-change

AWS Proton 正在寻找这个 JSON 文件。如果配置代码成功完成后文件存在，则从中 AWS Proton 读取输出参数值。