Menu
AWS CodeBuild
API Reference (API Version 2016-10-06)

ProjectEnvironment

Information about the build environment of the build project.

Contents

Note

In the following list, the required parameters are described first.

computeType

Information about the compute resources the build project will use. Available values include:

  • BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

  • BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

  • BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

Type: String

Valid Values: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE

Required: Yes

image

The ID of the Docker image to use for this build project.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

type

The type of build environment to use for related builds.

Type: String

Valid Values: LINUX_CONTAINER

Required: Yes

environmentVariables

A set of environment variables to make available to builds for this build project.

Type: Array of EnvironmentVariable objects

Required: No

privilegedMode

If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: