interface IBindableBuildImage

Language	Type name
.NET	Amazon.CDK.AWS.CodeBuild.IBindableBuildImage
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscodebuild#IBindableBuildImage
Java	software.amazon.awscdk.services.codebuild.IBindableBuildImage
Python	aws_cdk.aws_codebuild.IBindableBuildImage
TypeScript (source)	aws-cdk-lib » aws_codebuild » IBindableBuildImage

Implemented by LinuxGpuBuildImage

A variant of IBuildImage that allows binding to the project.

Properties

Name	Type	Description
defaultComputeType	ComputeType	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.
type	string	The type of build environment.
imagePullPrincipalType?	ImagePullPrincipalType	The type of principal that CodeBuild will use to pull this build Docker image.
repository?	IRepository	An optional ECR repository that the image is hosted in.
secretsManagerCredentials?	ISecret	The secretsManagerCredentials for access to a private registry.

---

defaultComputeType

Type: ComputeType

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

---

imageId

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

Type: string

The type of build environment.

---

imagePullPrincipalType?

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

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

---

repository?

Type: IRepository (optional, default: no repository)

An optional ECR repository that the image is hosted in.

---

secretsManagerCredentials?

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

The secretsManagerCredentials for access to a private registry.

Methods

Name	Description
bind(scope, project, options)	Function that allows the build image access to the construct tree.
runScriptBuildspec(entrypoint)	Make a buildspec to run the indicated script.
validate(buildEnvironment)	Allows the image a chance to validate whether the passed configuration is correct.

---

bind(scope, project, options)

public bind(scope: Construct, project: IProject, options: BuildImageBindOptions): BuildImageConfig

Parameters

• scope Construct
• project IProject
• options BuildImageBindOptions

Returns

• BuildImageConfig

Function that allows the build image access to the construct tree.

---

runScriptBuildspec(entrypoint)

public runScriptBuildspec(entrypoint: string): BuildSpec

Parameters

• entrypoint string

Returns

• BuildSpec

Make a buildspec to run the indicated script.

---

validate(buildEnvironment)

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.