aws-cdk-lib.aws_codebuild.IBindableBuildImage

IBindableBuildImage Interface

A variant of IBuildImage that allows binding to the project.

IBindableBuildImage

extends

• IBuildImage

implemented by

• LinuxGpuBuildImage

Source

aws-codebuild/lib/project.ts

Properties

defaultComputeTypeComputeTypedefault_compute_typeComputeTypedefaultComputeTypeComputeTypeDefaultComputeTypeComputeTypeDefaultComputeTypeComputeType#

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

imageIdstringimage_idstrimageIdStringImageIdstringImageId*string#

The Docker image identifier that the build environment uses.

imagePullPrincipalType?may be undefinedImagePullPrincipalTypeimage_pull_principal_type?may be undefinedImagePullPrincipalTypeimagePullPrincipalType?may be undefinedImagePullPrincipalTypeImagePullPrincipalType?may be undefinedImagePullPrincipalTypeImagePullPrincipalType?may be undefinedImagePullPrincipalType#

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

Default: ImagePullPrincipalType.SERVICE_ROLE

repository?may be undefinedIRepositoryrepository?may be undefinedIRepositoryrepository?may be undefinedIRepositoryRepository?may be undefinedIRepositoryRepository?may be undefinedIRepository#

An optional ECR repository that the image is hosted in.

Default: no repository

secretsManagerCredentials?may be undefinedISecretsecrets_manager_credentials?may be undefinedISecretsecretsManagerCredentials?may be undefinedISecretSecretsManagerCredentials?may be undefinedISecretSecretsManagerCredentials?may be undefinedISecret#

The secretsManagerCredentials for access to a private registry.

Default: no credentials will be used

typestringtypestrtypeStringTypestringType*string#

The type of build environment.

Methods

bind(scope: Construct, project: IProject, options: BuildImageBindOptions): BuildImageConfigdef bind(self, scope: Construct, project: IProject, options: BuildImageBindOptions) -> BuildImageConfigpublic BuildImageConfig bind(Construct scope, IProject project, BuildImageBindOptions options)public BuildImageConfig Bind(Construct scope, IProject project, BuildImageBindOptions options)func Bind(Scope Construct, Project IProject, Options BuildImageBindOptions) BuildImageConfig#

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

runScriptBuildspec(entrypoint: string): BuildSpecdef run_script_buildspec(self, entrypoint: str) -> BuildSpecpublic BuildSpec runScriptBuildspec(String entrypoint)public BuildSpec RunScriptBuildspec(string entrypoint)func RunScriptBuildspec(Entrypoint *string) BuildSpec#

Make a buildspec to run the indicated script.

validate(buildEnvironment: BuildEnvironment): string[]def validate(self, build_environment: BuildEnvironment) -> typing.List[str]public List<String> validate(BuildEnvironment buildEnvironment)public string[] Validate(BuildEnvironment buildEnvironment)func Validate(BuildEnvironment BuildEnvironment) *[]*string#

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

1 parameter

Parameters

• buildEnvironmentbuild_environmentbuildEnvironmentbuildEnvironmentBuildEnvironment — the current build environment.