Interface BuildEnvironment

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
BuildEnvironment.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:14.015Z") @Stability(Stable) public interface BuildEnvironment extends software.amazon.jsii.JsiiSerializable
Example:

 CodePipeline pipeline = CodePipeline.Builder.create(this, "Pipeline")
         .synth(ShellStep.Builder.create("Synth")
                 .input(CodePipelineSource.connection("my-org/my-app", "main", ConnectionSourceOptions.builder()
                         .connectionArn("arn:aws:codestar-connections:us-east-1:222222222222:connection/7d2469ff-514a-4e4f-9003-5ca4a43cdc41")
                         .build()))
                 .commands(List.of("npm ci", "npm run build", "npx cdk synth"))
                 .build())
         // Turn this on because the pipeline uses Docker image assets
         .dockerEnabledForSelfMutation(true)
         .build();
 pipeline.addWave("MyWave", WaveOptions.builder()
         .post(List.of(
             CodeBuildStep.Builder.create("RunApproval")
                     .commands(List.of("command-from-image"))
                     .buildEnvironment(BuildEnvironment.builder()
                             // The user of a Docker image asset in the pipeline requires turning on
                             // 'dockerEnabledForSelfMutation'.
                             .buildImage(LinuxBuildImage.fromAsset(this, "Image", DockerImageAssetProps.builder()
                                     .directory("./docker-image")
                                     .build()))
                             .build())
                     .build()))
         .build());
 
  • Method Details

    • getBuildImage

      @Stability(Stable) @Nullable default IBuildImage getBuildImage()
      The image used for the builds.

      Default: LinuxBuildImage.STANDARD_1_0

    • getCertificate

      @Stability(Stable) @Nullable default BuildEnvironmentCertificate getCertificate()
      The location of the PEM-encoded certificate for the build project.

      Default: - No external certificate is added to the project

    • getComputeType

      @Stability(Stable) @Nullable default ComputeType getComputeType()
      The type of compute to use for this build.

      See the ComputeType enum for the possible values.

      Default: taken from `#buildImage#defaultComputeType`

    • getEnvironmentVariables

      @Stability(Stable) @Nullable default Map<String,BuildEnvironmentVariable> getEnvironmentVariables()
      The environment variables that your builds can use.
    • getPrivileged

      @Stability(Stable) @Nullable default Boolean getPrivileged()
      Indicates how the project builds Docker images.

      Specify true to enable running the Docker daemon inside a Docker container. This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail.

      Default: false

    • builder

      @Stability(Stable) static BuildEnvironment.Builder builder()
      Returns:
      a BuildEnvironment.Builder of BuildEnvironment