Batch build buildspec reference

This topic contains the buildspec reference for batch build properties.

batch

Optional mapping. The batch build settings for the project.

batch/fast-fail

Optional. Specifies the behavior of the batch build when one or more build tasks fail.

false

The default value. All running builds will complete.

true

All running builds will be stopped when one of the build tasks fails.

By default, all batch build tasks run with the build settings such as env and phases, specified in the buildspec file. You can override the default build settings by specifying different env values or a different buildspec file in the batch/<batch-type>/buildspec parameter.

The contents of the batch property varies based on the type of batch build being specified. The possible batch build types are:

• batch/build-graph

• batch/build-list

• batch/build-matrix

batch/build-graph

Defines a build graph. A build graph defines a set of tasks that have dependencies on other tasks in the batch. For more information, see Build graph.

This element contains an array of build tasks. Each build task contains the following properties.

identifier

Required. The identifier of the task.

buildspec

Optional. The path and file name of the buildspec file to use for this task. If this parameter is not specified, the current buildspec file is used.

debug-session

Optional. A Boolean value that indicates whether session debugging is enabled for this batch build. For more information about session debugging, see View a running build in Session Manager.

false

Session debugging is disabled.

true

Session debugging is enabled.

depend-on

Optional. An array of task identifiers that this task depends on. This task will not run until these tasks are completed.

env

Optional. The build environment overrides for the task. This can contain the following properties:

compute-type

The identifier of the compute type to use for the task. See computeType in Build environment compute modes and types for possible values.

image

The identifier of the image to use for the task. See Image identifier in Docker images provided by CodeBuild for possible values.

privileged-mode

A Boolean value that indicates whether to run the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false.

type

The identifier of the environment type to use for the task. See Environment type in Build environment compute modes and types for possible values.

variables

The environment variables that will be present in the build environment. See env/variables for more information.

ignore-failure

Optional. A Boolean value that indicates if a failure of this build task can be ignored.

false

The default value. If this build task fails, the batch build will fail.

true

If this build task fails, the batch build can still succeed.

The following is an example of a build graph buildspec entry:

batch:
  fast-fail: false
  build-graph:
    - identifier: build1
      env:
        variables:
          BUILD_ID: build1
      ignore-failure: false
    - identifier: build2
      buildspec: build2.yml
      env:
        variables:
          BUILD_ID: build2
      depend-on:
        - build1
    - identifier: build3
      env:
        variables:
          BUILD_ID: build3
      depend-on:
        - build2

batch/build-list

Defines a build list. A build list is used to define a number of tasks that run in parallel. For more information, see Build list.

This element contains an array of build tasks. Each build task contains the following properties.

identifier

Required. The identifier of the task.

buildspec

Optional. The path and file name of the buildspec file to use for this task. If this parameter is not specified, the current buildspec file is used.

debug-session

Optional. A Boolean value that indicates whether session debugging is enabled for this batch build. For more information about session debugging, see View a running build in Session Manager.

false

Session debugging is disabled.

true

Session debugging is enabled.

env

Optional. The build environment overrides for the task. This can contain the following properties:

compute-type

The identifier of the compute type to use for the task. See computeType in Build environment compute modes and types for possible values.

image

The identifier of the image to use for the task. See Image identifier in Docker images provided by CodeBuild for possible values.

privileged-mode

A Boolean value that indicates whether to run the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false.

type

The identifier of the environment type to use for the task. See Environment type in Build environment compute modes and types for possible values.

variables

The environment variables that will be present in the build environment. See env/variables for more information.

ignore-failure

Optional. A Boolean value that indicates if a failure of this build task can be ignored.

false

The default value. If this build task fails, the batch build will fail.

true

If this build task fails, the batch build can still succeed.

The following is an example of a build list buildspec entry:

batch:
  fast-fail: false
  build-list:
    - identifier: build1
      env:
        variables:
          BUILD_ID: build1
      ignore-failure: false
    - identifier: build2
      buildspec: build2.yml
      env:
        variables:
          BUILD_ID: build2
      ignore-failure: true

batch/build-matrix

Defines a build matrix. A build matrix defines tasks with different configurations that run in parallel. CodeBuild creates a separate build for each possible configuration combination. For more information, see Build matrix.

static

The static properties apply to all build tasks.

ignore-failure

Optional. A Boolean value that indicates if a failure of this build task can be ignored.

false

The default value. If this build task fails, the batch build will fail.

true

If this build task fails, the batch build can still succeed.

env

Optional. The build environment overrides for all tasks.

privileged-mode

A Boolean value that indicates whether to run the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false.

type

The identifier of the environment type to use for the task. See Environment type in Build environment compute modes and types for possible values.

dynamic

The dynamic properties define the build matrix.

buildspec

Optional. An array that contains the path and file names of the buildspec files to use for these tasks. If this parameter is not specified, the current buildspec file is used.

env

Optional. The build environment overrides for these tasks.

compute-type

An array that contains the identifiers of the compute types to use for these tasks. See computeType in Build environment compute modes and types for possible values.

image

An array that contains the identifiers of the images to use for these tasks. See Image identifier in Docker images provided by CodeBuild for possible values.

variables

An array that contains the environment variables that will be present in the build environments for these tasks. See env/variables for more information.

The following is an example of a build matrix buildspec entry:

batch:
  build-matrix:
    static:
      ignore-failure: false
    dynamic:
      buildspec: 
        - matrix1.yml
        - matrix2.yml
      env:
        variables:
          MY_VAR:
            - VALUE1
            - VALUE2
            - VALUE3

For more information, see Build matrix.