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
,LinuxBuildImage
,LinuxGpuBuildImage
,WindowsBuildImage
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:41.797Z")
@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
Modifier and TypeInterfaceDescriptionstatic interface
Internal default implementation forIBuildImage
.static final class
A proxy class which represents a concrete javascript instance of this type. -
Method Summary
Modifier and TypeMethodDescriptionThe defaultComputeType
to use with this image, if one was not specified inBuildEnvironment#computeType
explicitly.The Docker image identifier that the build environment uses.default ImagePullPrincipalType
The type of principal that CodeBuild will use to pull this build Docker image.default IRepository
An optional ECR repository that the image is hosted in.default ISecret
The secretsManagerCredentials for access to a private registry.getType()
The type of build environment.runScriptBuildspec
(String entrypoint) Make a buildspec to run the indicated script.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
The defaultComputeType
to use with this image, if one was not specified inBuildEnvironment#computeType
explicitly. -
getImageId
The Docker image identifier that the build environment uses. -
getType
The type of build environment. -
getImagePullPrincipalType
The type of principal that CodeBuild will use to pull this build Docker image.Default: ImagePullPrincipalType.SERVICE_ROLE
-
getRepository
An optional ECR repository that the image is hosted in.Default: no repository
-
getSecretsManagerCredentials
The secretsManagerCredentials for access to a private registry.Default: no credentials will be used
-
runScriptBuildspec
Make a buildspec to run the indicated script.- Parameters:
entrypoint
- This parameter is required.
-
validate
Allows the image a chance to validate whether the passed configuration is correct.- Parameters:
buildEnvironment
- the current build environment. This parameter is required.
-