CodeBuild provisioning parameter details and examples

You can define parameters in your templates for CodeBuild-based AWS Proton resources and reference these parameters in your provisioning code. For a detailed description of AWS Proton parameters, parameter types, the parameter namespace, and how to use parameters in your IaC files, see AWS Proton parameters.

Input parameters

When you create an AWS Proton resource, like an environment or a service, you provide values for input parameters that are defined in your template's schema file. When the resource that you create uses CodeBuild provisioning, AWS Proton renders these input values into an input file. Your provisioning code can import and get parameter values from this file.

For an example of a CodeBuild templates, see CodeBuild provisioning template bundle. For more information about manifest files, see Wrap up template files for AWS Proton.

The following example is a JSON input file generated during CodeBuild-based provisioning of a service instance.

{
  "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"
    }
  }
}

Output parameters

To communicate resource provisioning outputs back to AWS Proton, your provisioning code can generate a JSON file named proton-outputs.json with values for output parameters defined in your template's schema file. For example, the cdk deploy command has the --outputs-file argument that instructs the AWS CDK to generate a JSON file with provisioning outputs. If your resource uses the AWS CDK, specify the following command in your CodeBuild template manifest:

aws proton notify-resource-deployment-status-change

AWS Proton looks for this JSON file. If the file exists after your provisioning code successfully completes, AWS Proton reads output parameter values from it.