Package software.amazon.awscdk.services.codebuild

Interface IBuildImage

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IBindableBuildImage, IBindableBuildImage.Jsii$Default, IBuildImage.Jsii$Default

All Known Implementing Classes:

IBindableBuildImage.Jsii$Proxy, IBuildImage.Jsii$Proxy, LinuxArmBuildImage, LinuxArmLambdaBuildImage, LinuxBuildImage, LinuxGpuBuildImage, LinuxLambdaBuildImage, MacBuildImage, WindowsBuildImage

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:34.792Z")
@Stability(Stable)
public interface IBuildImage
extends software.amazon.jsii.JsiiSerializable

Represents a Docker image used for the CodeBuild Project builds.

Use the concrete subclasses, either: LinuxBuildImage or WindowsBuildImage.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IBuildImage.Jsii$Default	Internal default implementation for IBuildImage.
static final class	IBuildImage.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
ComputeType	getDefaultComputeType()	The default ComputeType to use with this image, if one was not specified in BuildEnvironment#computeType explicitly.
String	getImageId()	The Docker image identifier that the build environment uses.
default ImagePullPrincipalType	getImagePullPrincipalType()	The type of principal that CodeBuild will use to pull this build Docker image.
default IRepository	getRepository()	An optional ECR repository that the image is hosted in.
default ISecret	getSecretsManagerCredentials()	The secretsManagerCredentials for access to a private registry.
String	getType()	The type of build environment.
BuildSpec	runScriptBuildspec(String entrypoint)	Make a buildspec to run the indicated script.
List<String>	validate(BuildEnvironment buildEnvironment)	Allows the image a chance to validate whether the passed configuration is correct.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultComputeType

@Stability(Stable)
@NotNull
ComputeType getDefaultComputeType()

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

getImageId

@Stability(Stable)
@NotNull
String getImageId()

The Docker image identifier that the build environment uses.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

The type of build environment.

getImagePullPrincipalType

@Stability(Stable)
@Nullable
default ImagePullPrincipalType getImagePullPrincipalType()

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

Default: ImagePullPrincipalType.SERVICE_ROLE

getRepository

@Stability(Stable)
@Nullable
default IRepository getRepository()

An optional ECR repository that the image is hosted in.

Default: no repository

getSecretsManagerCredentials

@Stability(Stable)
@Nullable
default ISecret getSecretsManagerCredentials()

The secretsManagerCredentials for access to a private registry.

Default: no credentials will be used

runScriptBuildspec

@Stability(Stable)
@NotNull
BuildSpec runScriptBuildspec(@NotNull
 String entrypoint)

Make a buildspec to run the indicated script.

Parameters:

entrypoint - This parameter is required.

validate

@Stability(Stable)
@NotNull
List<String> validate(@NotNull
 BuildEnvironment buildEnvironment)

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

Parameters:

buildEnvironment - the current build environment. This parameter is required.