Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS CodeBuild Resource Types Reference » AWS::CodeBuild::Project » AWS CodeBuild Project Environment

AWS CodeBuild Project Environment

Environment is a property of the AWS::CodeBuild::Project resource that specifies the environment for an AWS CodeBuild project.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Certificate" : String,
  "ComputeType" : String,
  "EnvironmentVariables" : [ EnvironmentVariable ],
  "Image" : String,
  "PrivilegedMode" : Boolean,
  "Type" : String
}

YAML

Certificate: String
ComputeType: String
EnvironmentVariables:
  - EnvironmentVariable
Image: String
PrivilegedMode: Boolean
Type: String

Properties

Certificate

The certificate to use with the build project.

Required: No

Type: String

ComputeType

The type of compute environment, such as BUILD_GENERAL1_SMALL. The compute type determines the number of CPU cores and memory the build environment uses. For valid values, see the computeType field in the AWS CodeBuild User Guide.

Required: Yes

Type: String

EnvironmentVariables

The environment variables that your builds can use. For more information, see the environmentVariables field in the AWS CodeBuild User Guide.

Required: No

Type: List of AWS CodeBuild Project EnvironmentVariable

Image

The Docker image identifier that the build environment uses. For more information, see the image field in the AWS CodeBuild User Guide.

Required: Yes

Type: String

PrivilegedMode

Indicates how the project builds Docker images. Specify true to enable running the Docker daemon inside a Docker container.

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. For more information, see the privilegedMode field in the AWS CodeBuild User Guide.

Required: No

Type: Boolean

Type

The type of build environment. For valid values, see the environment-type field in the AWS CodeBuild User Guide.

Required: Yes

Type: String

On this page: