Implemented by LinuxArmBuildImage, LinuxArmLambdaBuildImage, LinuxBuildImage, LinuxGpuBuildImage, LinuxLambdaBuildImage, MacBuildImage, WindowsBuildImage

Obtainable from LinuxArmBuildImage.fromCodeBuildImageId(), LinuxArmBuildImage.fromDockerRegistry(), LinuxArmBuildImage.fromEcrRepository(), LinuxBuildImage.fromAsset(), LinuxBuildImage.fromCodeBuildImageId(), LinuxBuildImage.fromDockerRegistry(), LinuxBuildImage.fromEcrRepository(), LinuxGpuBuildImage.awsDeepLearningContainersImage(), LinuxGpuBuildImage.fromEcrRepository(), MacBuildImage.fromAsset(), MacBuildImage.fromDockerRegistry(), MacBuildImage.fromEcrRepository(), WindowsBuildImage.fromAsset(), WindowsBuildImage.fromDockerRegistry(), WindowsBuildImage.fromEcrRepository()

Represents a Docker image used for the CodeBuild Project builds.

Use the concrete subclasses, either: LinuxBuildImage or WindowsBuildImage.

Type: ComputeType

The default ComputeType to use with this image, if one was not specified in BuildEnvironment#computeType explicitly.

Type: string

The Docker image identifier that the build environment uses.

See also: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html

Type: string

The type of build environment.

Type: ImagePullPrincipalType (optional, default: ImagePullPrincipalType.SERVICE_ROLE)

The type of principal that CodeBuild will use to pull this build Docker image.

Type: IRepository (optional, default: no repository)

An optional ECR repository that the image is hosted in.

Type: ISecret (optional, default: no credentials will be used)

The secretsManagerCredentials for access to a private registry.

public runScriptBuildspec(entrypoint: string): BuildSpec

Parameters

• entrypoint string

Returns

• BuildSpec

Make a buildspec to run the indicated script.

public validate(buildEnvironment: BuildEnvironment): string[]

Parameters

• buildEnvironment BuildEnvironment — the current build environment.

Returns

• string[]

Allows the image a chance to validate whether the passed configuration is correct.