AWS CDK Reference

Appearance

v2.273.0

BuildEnvironment Struct ​

Source
aws-codebuild/lib/project.ts
Type last changed
v2.271.0 · 25 Sep 2026

Example ​

ts
const pipeline = new pipelines.CodePipeline(this, 'Pipeline', {
  synth: new pipelines.ShellStep('Synth', {
    input: pipelines.CodePipelineSource.connection('my-org/my-app', 'main', {
      connectionArn:
        'arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41', // Created using the AWS console * });',
    }),
    commands: ['npm ci', 'npm run build', 'npx cdk synth'],
  }),

  // Turn this on because the pipeline uses Docker image assets
  dockerEnabledForSelfMutation: true,
});

pipeline.addWave('MyWave', {
  post: [
    new pipelines.CodeBuildStep('RunApproval', {
      commands: ['command-from-image'],
      buildEnvironment: {
        // The user of a Docker image asset in the pipeline requires turning on
        // 'dockerEnabledForSelfMutation'.
        buildImage: codebuild.LinuxBuildImage.fromAsset(this, 'Image', {
          directory: './docker-image',
        }),
      },
    }),
  ],
});

Properties ​

buildImageIBuildImagebuild_imageIBuildImagebuildImageIBuildImageBuildImageIBuildImageBuildImageIBuildImage= LinuxBuildImage.STANDARD_7_0#
The image used for the builds.
certificateBuildEnvironmentCertificatecertificateBuildEnvironmentCertificatecertificateBuildEnvironmentCertificateCertificateBuildEnvironmentCertificateCertificateBuildEnvironmentCertificate= No external certificate is added…#
The location of the PEM-encoded certificate for the build project.
default

Default: No external certificate is added to the project

computeTypeComputeTypecompute_typeComputeTypecomputeTypeComputeTypeComputeTypeComputeTypeComputeTypeComputeType= taken from `#buildImage#defaultC…#
The type of compute to use for this build.

See the ComputeType enum for the possible values.

default

Default: taken from #buildImage#defaultComputeType

dockerServerDockerServerOptionsdocker_serverDockerServerOptionsdockerServerDockerServerOptionsDockerServerDockerServerOptionsDockerServerDockerServerOptions= Doesn't use remote docker server#
The Docker server configuration CodeBuild use to build your Docker image.
environmentVariables{ [key: string]: BuildEnvironmentVariable }environment_variablestyping.Mapping[str, BuildEnvironmentVariable]environmentVariablesMap<String, BuildEnvironmentVariable>EnvironmentVariablesIDictionary<string, BuildEnvironmentVariable>EnvironmentVariables*map[string]BuildEnvironmentVariable#
The environment variables that your builds can use.
fleetIFleetfleetIFleetfleetIFleetFleetIFleetFleetIFleet= No fleet will be attached to the…#
Fleet resource for a reserved capacity CodeBuild project.

Fleets allow for process builds or tests to run immediately and reduces build durations, by reserving compute resources for your projects.

You will be charged for the resources in the fleet, even if they are idle.

default

Default: No fleet will be attached to the project, which will remain on-demand.

hostKernelHostKernelhost_kernelHostKernelhostKernelHostKernelHostKernelHostKernelHostKernelHostKernel= the default host kernel chosen b…#
The host operating system kernel used for the builds.
notes · default

The host kernel does not affect the build environment operating system, which is determined by the buildImage.

Only supported by the LINUX_CONTAINER, ARM_CONTAINER, LINUX_EC2 and ARM_EC2 environment types. Not supported by Windows, Lambda or Mac build images.

Default: the default host kernel chosen by CodeBuild for the build image

privilegedbooleanprivilegedboolprivilegedBooleanPrivilegedboolPrivileged*bool= false#
Indicates how the project builds Docker images.
notes

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.