# EnvironmentProperty

`Environment` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies the environment for an AWS CodeBuild project.

- Source: Generated at build time
- Type last changed: v2.262.0 · 22 Jul 2026

## Example

TypeScript:

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const environmentProperty: codebuild.CfnProject.EnvironmentProperty = {
  computeType: 'computeType',
  image: 'image',
  type: 'type',

  // the properties below are optional
  certificate: 'certificate',
  dockerServer: {
    computeType: 'computeType',

    // the properties below are optional
    securityGroupIds: ['securityGroupIds'],
  },
  environmentVariables: [{
    name: 'name',
    value: 'value',

    // the properties below are optional
    type: 'type',
  }],
  fleet: {
    fleetArn: 'fleetArn',
  },
  hostKernel: 'hostKernel',
  imagePullCredentialsType: 'imagePullCredentialsType',
  privilegedMode: false,
  registryCredential: {
    credential: 'credential',
    credentialProvider: 'credentialProvider',
  },
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codebuild as codebuild

environment_property = codebuild.CfnProject.EnvironmentProperty(
    compute_type="computeType",
    image="image",
    type="type",

    # the properties below are optional
    certificate="certificate",
    docker_server=codebuild.CfnProject.DockerServerProperty(
        compute_type="computeType",

        # the properties below are optional
        security_group_ids=["securityGroupIds"]
    ),
    environment_variables=[codebuild.CfnProject.EnvironmentVariableProperty(
        name="name",
        value="value",

        # the properties below are optional
        type="type"
    )],
    fleet=codebuild.CfnProject.ProjectFleetProperty(
        fleet_arn="fleetArn"
    ),
    host_kernel="hostKernel",
    image_pull_credentials_type="imagePullCredentialsType",
    privileged_mode=False,
    registry_credential=codebuild.CfnProject.RegistryCredentialProperty(
        credential="credential",
        credential_provider="credentialProvider"
    )
)
```

Java:

```java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codebuild.*;

EnvironmentProperty environmentProperty = EnvironmentProperty.builder()
        .computeType("computeType")
        .image("image")
        .type("type")

        // the properties below are optional
        .certificate("certificate")
        .dockerServer(DockerServerProperty.builder()
                .computeType("computeType")

                // the properties below are optional
                .securityGroupIds(List.of("securityGroupIds"))
                .build())
        .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                .name("name")
                .value("value")

                // the properties below are optional
                .type("type")
                .build()))
        .fleet(ProjectFleetProperty.builder()
                .fleetArn("fleetArn")
                .build())
        .hostKernel("hostKernel")
        .imagePullCredentialsType("imagePullCredentialsType")
        .privilegedMode(false)
        .registryCredential(RegistryCredentialProperty.builder()
                .credential("credential")
                .credentialProvider("credentialProvider")
                .build())
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeBuild;

var environmentProperty = new EnvironmentProperty {
    ComputeType = "computeType",
    Image = "image",
    Type = "type",

    // the properties below are optional
    Certificate = "certificate",
    DockerServer = new DockerServerProperty {
        ComputeType = "computeType",

        // the properties below are optional
        SecurityGroupIds = new [] { "securityGroupIds" }
    },
    EnvironmentVariables = new [] { new EnvironmentVariableProperty {
        Name = "name",
        Value = "value",

        // the properties below are optional
        Type = "type"
    } },
    Fleet = new ProjectFleetProperty {
        FleetArn = "fleetArn"
    },
    HostKernel = "hostKernel",
    ImagePullCredentialsType = "imagePullCredentialsType",
    PrivilegedMode = false,
    RegistryCredential = new RegistryCredentialProperty {
        Credential = "credential",
        CredentialProvider = "credentialProvider"
    }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

environmentProperty := &EnvironmentProperty{
	ComputeType: jsii.String("computeType"),
	Image: jsii.String("image"),
	Type: jsii.String("type"),

	// the properties below are optional
	Certificate: jsii.String("certificate"),
	DockerServer: &DockerServerProperty{
		ComputeType: jsii.String("computeType"),

		// the properties below are optional
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
	},
	EnvironmentVariables: []interface{}{
		&EnvironmentVariableProperty{
			Name: jsii.String("name"),
			Value: jsii.String("value"),

			// the properties below are optional
			Type: jsii.String("type"),
		},
	},
	Fleet: &ProjectFleetProperty{
		FleetArn: jsii.String("fleetArn"),
	},
	HostKernel: jsii.String("hostKernel"),
	ImagePullCredentialsType: jsii.String("imagePullCredentialsType"),
	PrivilegedMode: jsii.Boolean(false),
	RegistryCredential: &RegistryCredentialProperty{
		Credential: jsii.String("credential"),
		CredentialProvider: jsii.String("credentialProvider"),
	},
}
```

## Properties

- `certificate`: string — The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project.

  For more information, see [certificate](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate) in the *AWS CodeBuild User Guide* .

- `computeType`: string (required) — The type of compute environment.

  This determines the number of CPU cores and memory the build environment uses. Available values include:

  - `ATTRIBUTE_BASED_COMPUTE` : Specify the amount of vCPUs, memory, disk space, and the type of machine.

  > If you use `ATTRIBUTE_BASED_COMPUTE` , you must define your attributes by using `computeConfiguration` . AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see [Reserved capacity environment types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.types) in the *AWS CodeBuild User Guide* .
  - `BUILD_GENERAL1_SMALL` : Use up to 4 GiB memory and 2 vCPUs for builds.
  - `BUILD_GENERAL1_MEDIUM` : Use up to 8 GiB memory and 4 vCPUs for builds.
  - `BUILD_GENERAL1_LARGE` : Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
  - `BUILD_GENERAL1_XLARGE` : Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
  - `BUILD_GENERAL1_2XLARGE` : Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
  - `BUILD_LAMBDA_1GB` : Use up to 1 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER` .
  - `BUILD_LAMBDA_2GB` : Use up to 2 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER` .
  - `BUILD_LAMBDA_4GB` : Use up to 4 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER` .
  - `BUILD_LAMBDA_8GB` : Use up to 8 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER` .
  - `BUILD_LAMBDA_10GB` : Use up to 10 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER` .

  If you use `BUILD_GENERAL1_SMALL` :

  - For environment type `LINUX_CONTAINER` , you can use up to 4 GiB memory and 2 vCPUs for builds.
  - For environment type `LINUX_GPU_CONTAINER` , you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
  - For environment type `ARM_CONTAINER` , you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.

  If you use `BUILD_GENERAL1_LARGE` :

  - For environment type `LINUX_CONTAINER` , you can use up to 16 GiB memory and 8 vCPUs for builds.
  - For environment type `LINUX_GPU_CONTAINER` , you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
  - For environment type `ARM_CONTAINER` , you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

  For more information, see [On-demand environment types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types) in the *AWS CodeBuild User Guide.*

- `dockerServer`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.DockerServerProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.DockerServerProperty.html)

- `environmentVariables`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.EnvironmentVariableProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.EnvironmentVariableProperty.html)[] — A set of environment variables to make available to builds for this build project.

- `fleet`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.ProjectFleetProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.ProjectFleetProperty.html)

- `hostKernel`: string — The kernel version of the host operating system for the build environment.

  Allowed values: LINUX_KERNEL_4 | LINUX_KERNEL_6 | LINUX_KERNEL_LATEST

- `image`: string (required) — The image tag or image digest that identifies the Docker image to use for this build project.

  Use the following formats:

  - For an image tag: `<registry>/<repository>:<tag>` . For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be `aws/codebuild/standard:4.0` .
  - For an image digest: `<registry>/<repository>@<digest>` . For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use `<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf` .

  For more information, see [Docker images provided by CodeBuild](https://docs.aws.amazon.com//codebuild/latest/userguide/build-env-ref-available.html) in the *AWS CodeBuild user guide* .

- `imagePullCredentialsType`: string — The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:.

  - `CODEBUILD` specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal.
  - `SERVICE_ROLE` specifies that AWS CodeBuild uses your build project's service role.

  When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.

- `privilegedMode`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Enables running 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` .

  You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:

  If the operating system's base image is Ubuntu Linux:

  `- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&`

  `- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"`

  If the operating system's base image is Alpine Linux and the previous command does not work, add the `-t` argument to `timeout` :

  `- 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"`

- `registryCredential`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnProject.RegistryCredentialProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.CfnProject.RegistryCredentialProperty.html) — `RegistryCredential` is a property of the [AWS::CodeBuild::Project Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-environment) property that specifies information about credentials that provide access to a private Docker registry. When this is set:.

  - `imagePullCredentialsType` must be set to `SERVICE_ROLE` .
  - images cannot be curated or an Amazon ECR image.

- `type`: string (required) — The type of build environment to use for related builds.

  > If you're using compute fleets during project creation, `type` will be ignored.

  For more information, see [Build environment compute types](https://docs.aws.amazon.com//codebuild/latest/userguide/build-env-ref-compute-types.html) in the *AWS CodeBuild user guide* .
