# LinuxBuildImage

A CodeBuild image running x86-64 Linux.

This class has a bunch of public constants that represent the most popular images.

You can also specify a custom image using one of the static methods:

- LinuxBuildImage.fromDockerRegistry(image[, { secretsManagerCredentials }])
- LinuxBuildImage.fromEcrRepository(repo[, tag])
- LinuxBuildImage.fromAsset(parent, id, props)

Implements: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html)

- Source: [`aws-codebuild/lib/project.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/aws-cdk-lib/aws-codebuild/lib/project.ts#L1856)
- Type last changed: v2.274.0 · 20 Oct 2026

## Example

TypeScript:

```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',
        }),
      },
    }),
  ],
});
```

Python:

```python
pipeline = pipelines.CodePipeline(self, "Pipeline",
    synth=pipelines.ShellStep("Synth",
        input=pipelines.CodePipelineSource.connection("my-org/my-app", "main",
            connection_arn="arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"
        ),
        commands=["npm ci", "npm run build", "npx cdk synth"]
    ),

    # Turn this on because the pipeline uses Docker image assets
    docker_enabled_for_self_mutation=True
)

pipeline.add_wave("MyWave",
    post=[
        pipelines.CodeBuildStep("RunApproval",
            commands=["command-from-image"],
            build_environment=codebuild.BuildEnvironment(
                # The user of a Docker image asset in the pipeline requires turning on
                # 'dockerEnabledForSelfMutation'.
                build_image=codebuild.LinuxBuildImage.from_asset(self, "Image",
                    directory="./docker-image"
                )
            )
        )
    ]
)
```

Java:

```java
CodePipeline pipeline = CodePipeline.Builder.create(this, "Pipeline")
        .synth(ShellStep.Builder.create("Synth")
                .input(CodePipelineSource.connection("my-org/my-app", "main", ConnectionSourceOptions.builder()
                        .connectionArn("arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41")
                        .build()))
                .commands(List.of("npm ci", "npm run build", "npx cdk synth"))
                .build())

        // Turn this on because the pipeline uses Docker image assets
        .dockerEnabledForSelfMutation(true)
        .build();

pipeline.addWave("MyWave", WaveOptions.builder()
        .post(List.of(
            CodeBuildStep.Builder.create("RunApproval")
                    .commands(List.of("command-from-image"))
                    .buildEnvironment(BuildEnvironment.builder()
                            // The user of a Docker image asset in the pipeline requires turning on
                            // 'dockerEnabledForSelfMutation'.
                            .buildImage(LinuxBuildImage.fromAsset(this, "Image", DockerImageAssetProps.builder()
                                    .directory("./docker-image")
                                    .build()))
                            .build())
                    .build()))
        .build());
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
var pipeline = new CodePipeline(this, "Pipeline", new CodePipelineProps {
    Synth = new ShellStep("Synth", new ShellStepProps {
        Input = CodePipelineSource.Connection("my-org/my-app", "main", new ConnectionSourceOptions {
            ConnectionArn = "arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"
        }),
        Commands = new [] { "npm ci", "npm run build", "npx cdk synth" }
    }),

    // Turn this on because the pipeline uses Docker image assets
    DockerEnabledForSelfMutation = true
});

pipeline.AddWave("MyWave", new WaveOptions {
    Post = new [] {
        new CodeBuildStep("RunApproval", new CodeBuildStepProps {
            Commands = new [] { "command-from-image" },
            BuildEnvironment = new BuildEnvironment {
                // The user of a Docker image asset in the pipeline requires turning on
                // 'dockerEnabledForSelfMutation'.
                BuildImage = LinuxBuildImage.FromAsset(this, "Image", new DockerImageAssetProps {
                    Directory = "./docker-image"
                })
            }
        }) }
});
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
pipeline := pipelines.NewCodePipeline(this, jsii.String("Pipeline"), &CodePipelineProps{
	Synth: pipelines.NewShellStep(jsii.String("Synth"), &ShellStepProps{
		Input: pipelines.CodePipelineSource_Connection(jsii.String("my-org/my-app"), jsii.String("main"), &ConnectionSourceOptions{
			ConnectionArn: jsii.String("arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41"),
		}),
		Commands: []*string{
			jsii.String("npm ci"),
			jsii.String("npm run build"),
			jsii.String("npx cdk synth"),
		},
	}),

	// Turn this on because the pipeline uses Docker image assets
	DockerEnabledForSelfMutation: jsii.Boolean(true),
})

pipeline.AddWave(jsii.String("MyWave"), &WaveOptions{
	Post: []Step{
		pipelines.NewCodeBuildStep(jsii.String("RunApproval"), &CodeBuildStepProps{
			Commands: []*string{
				jsii.String("command-from-image"),
			},
			BuildEnvironment: &BuildEnvironment{
				// The user of a Docker image asset in the pipeline requires turning on
				// 'dockerEnabledForSelfMutation'.
				BuildImage: codebuild.LinuxBuildImage_FromAsset(this, jsii.String("Image"), &DockerImageAssetProps{
					Directory: jsii.String("./docker-image"),
				}),
			},
		}),
	},
})
```

## Properties

- `AMAZON_LINUX_2`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — Use {@link LinuxBuildImage.AMAZON_LINUX_2_5 } instead.

- `AMAZON_LINUX_2_2`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — Use {@link LinuxBuildImage.AMAZON_LINUX_2_5 } instead.

- `AMAZON_LINUX_2_3`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — Use {@link LinuxBuildImage.AMAZON_LINUX_2_5 } instead.

- `AMAZON_LINUX_2_4`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The Amazon Linux 2 x86_64 standard image, version `4.0`.

- `AMAZON_LINUX_2_5`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The Amazon Linux 2023 x86_64 standard image, version `5.0`.

- `AMAZON_LINUX_2_ARM`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — Use {@link LinuxArmBuildImage.AMAZON_LINUX_2_ARM_3 } instead.

- `AMAZON_LINUX_2_ARM_2`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — Image "aws/codebuild/amazonlinux2-aarch64-standard:2.0".

- `AMAZON_LINUX_2_ARM_3`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — Image "aws/codebuild/amazonlinux2-aarch64-standard:3.0".

- `AMAZON_LINUX_2_CORETTO_11`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The Amazon Coretto 11 image x86_64, based on Amazon Linux 2.

- `AMAZON_LINUX_2_CORETTO_8`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The Amazon Coretto 8 image x86_64, based on Amazon Linux 2.

- `AMAZON_LINUX_2023_4`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The Amazon Linux 2023 x86_64 standard image, version `4.0`.

- `AMAZON_LINUX_2023_5`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The Amazon Linux 2023 x86_64 standard image, version `5.0`.

- `AMAZON_LINUX_2023_6`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The Amazon Linux 2023 x86_64 standard image, version `6.0`.

- `AMAZON_LINUX_2023_CORETTO_11`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The Amazon Coretto 11 image x86_64, based on Amazon Linux 2023.

- `AMAZON_LINUX_2023_CORETTO_8`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The Amazon Coretto 8 image x86_64, based on Amazon Linux 2023.

- `defaultComputeType`: [ComputeType](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.ComputeType.html) — The default `ComputeType` to use with this image, if one was not specified in `BuildEnvironment#computeType` explicitly.

- `imageId`: string — The Docker image identifier that the build environment uses.

- `imagePullPrincipalType`: [ImagePullPrincipalType](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.ImagePullPrincipalType.html) — The type of principal that CodeBuild will use to pull this build Docker image.

- `repository`: [IRepository](/cdk/api/v2/docs/aws-cdk-lib.aws_ecr.IRepository.html) — An optional ECR repository that the image is hosted in.

- `secretsManagerCredentials`: [ISecret](/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager.ISecret.html) — The secretsManagerCredentials for access to a private registry.

- `STANDARD_1_0`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — Use {@link LinuxBuildImage.STANDARD_7_0 } instead.

- `STANDARD_2_0`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — Use {@link LinuxBuildImage.STANDARD_7_0 } instead.

- `STANDARD_3_0`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — Use {@link LinuxBuildImage.STANDARD_7_0 } instead.

- `STANDARD_4_0`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — Use {@link LinuxBuildImage.STANDARD_7_0 } instead.

- `STANDARD_5_0`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The `aws/codebuild/standard:5.0` build image.

- `STANDARD_6_0`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The `aws/codebuild/standard:6.0` build image.

- `STANDARD_7_0`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The `aws/codebuild/standard:7.0` build image.

- `STANDARD_8_0`: [IBuildImage](/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.IBuildImage.html) (static) — The `aws/codebuild/standard:8.0` build image.

- `type`: string — The type of build environment.

## Methods

- `fromAsset(scope: Construct, id: string, props: DockerImageAssetProps): IBuildImage` (static) — Uses an Docker image asset as a x86-64 Linux build image.

- `fromCodeBuildImageId(id: string): IBuildImage` (static) — Uses a Docker image provided by CodeBuild.

  **Parameters**

  - `id` — The image identifier.

  **Returns:** A Docker image provided by CodeBuild.

  ```ts
  'aws/codebuild/standard:4.0'
  ```

- `fromDockerRegistry(name: string, options?: DockerImageOptions): IBuildImage` (static)

  **Returns:** a x86-64 Linux build image from a Docker Hub image.

- `fromEcrRepository(repository: IRepository, tagOrDigest?: string): IBuildImage` (static)

  **Parameters**

  - `repository` — The ECR repository.
  - `tagOrDigest` — Image tag or digest (default "latest", digests must start with `sha256:`).

  **Returns:** A x86-64 Linux build image from an ECR repository. NOTE: if the repository is external (i.e. imported), then we won't be able to add a resource policy statement for it so CodeBuild can pull the image.

- `runScriptBuildspec(entrypoint: string): BuildSpec` — Make a buildspec to run the indicated script.

- `validate(env: BuildEnvironment): string[]` — Allows the image a chance to validate whether the passed configuration is correct.
