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, WindowsBuildImage

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)", date="2024-04-10T22:22:25.139Z") @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.

  • 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:
    • 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.