Package software.amazon.awscdk.services.codebuild

Class CfnProject.EnvironmentProperty.Builder

java.lang.Object
software.amazon.awscdk.services.codebuild.CfnProject.EnvironmentProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnProject.EnvironmentProperty>
Enclosing interface:
CfnProject.EnvironmentProperty
@Stability(Stable) public static final class CfnProject.EnvironmentProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnProject.EnvironmentProperty>
A builder for CfnProject.EnvironmentProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • computeType

      @Stability(Stable) public CfnProject.EnvironmentProperty.Builder computeType(String computeType)
      Sets the value of CfnProject.EnvironmentProperty.getComputeType()
      Parameters:
      computeType - The type of compute environment. This parameter is required. This determines the number of CPU cores and memory the build environment uses. Available values include:

      • BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds.
      • BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds.
      • BUILD_GENERAL1_LARGE : Use up to 15 GB memory and 8 vCPUs for builds.

      For more information, see Build Environment Compute Types in the AWS CodeBuild User Guide.

      Returns:
      this

    • image

      @Stability(Stable) public CfnProject.EnvironmentProperty.Builder image(String image)
      Sets the value of CfnProject.EnvironmentProperty.getImage()
      Parameters:
      image - The image tag or image digest that identifies the Docker image to use for this build project. This parameter is required. Use the following formats:

      • For an image tag: <registry>/<repository>:<tag> . For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0 .
      • For an image digest: <registry>/<repository>@<digest> . For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf .

      For more information, see Docker images provided by CodeBuild in the AWS CodeBuild user guide .

      Returns:
      this

    • type

      @Stability(Stable) public CfnProject.EnvironmentProperty.Builder type(String type)
      Sets the value of CfnProject.EnvironmentProperty.getType()
      Parameters:
      type - The type of build environment to use for related builds. This parameter is required.
      • The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).
      • The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
      • The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
      • The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).

      For more information, see Build environment compute types in the AWS CodeBuild user guide .

      Returns:
      this

    • certificate

      @Stability(Stable) public CfnProject.EnvironmentProperty.Builder certificate(String certificate)
      Sets the value of CfnProject.EnvironmentProperty.getCertificate()
      Parameters:
      certificate - The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the AWS CodeBuild User Guide .
      Returns:
      this

    • environmentVariables

      @Stability(Stable) public CfnProject.EnvironmentProperty.Builder environmentVariables(IResolvable environmentVariables)
      Sets the value of CfnProject.EnvironmentProperty.getEnvironmentVariables()
      Parameters:
      environmentVariables - A set of environment variables to make available to builds for this build project.
      Returns:
      this

    • environmentVariables

      @Stability(Stable) public CfnProject.EnvironmentProperty.Builder environmentVariables(List<? extends Object> environmentVariables)
      Sets the value of CfnProject.EnvironmentProperty.getEnvironmentVariables()
      Parameters:
      environmentVariables - A set of environment variables to make available to builds for this build project.
      Returns:
      this

    • imagePullCredentialsType

      @Stability(Stable) public CfnProject.EnvironmentProperty.Builder imagePullCredentialsType(String imagePullCredentialsType)
      Sets the value of CfnProject.EnvironmentProperty.getImagePullCredentialsType()
      Parameters:
      imagePullCredentialsType - The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:.
      • CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal.
      • SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.

      When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.

      Returns:
      this

    • privilegedMode

      @Stability(Stable) public CfnProject.EnvironmentProperty.Builder privilegedMode(Boolean privilegedMode)
      Sets the value of CfnProject.EnvironmentProperty.getPrivilegedMode()
      Parameters:
      privilegedMode - Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false .

      You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:

      If the operating system's base image is Ubuntu Linux:

      - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

      - timeout 15 sh -c "until docker info; do echo .; sleep 1; done"

      If the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout :

      - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

      - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

      Returns:
      this

    • privilegedMode

      @Stability(Stable) public CfnProject.EnvironmentProperty.Builder privilegedMode(IResolvable privilegedMode)
      Sets the value of CfnProject.EnvironmentProperty.getPrivilegedMode()
      Parameters:
      privilegedMode - Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false .

      You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:

      If the operating system's base image is Ubuntu Linux:

      - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

      - timeout 15 sh -c "until docker info; do echo .; sleep 1; done"

      If the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout :

      - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

      - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

      Returns:
      this

    • registryCredential

      @Stability(Stable) public CfnProject.EnvironmentProperty.Builder registryCredential(IResolvable registryCredential)
      Sets the value of CfnProject.EnvironmentProperty.getRegistryCredential()
      Parameters:
      registryCredential - RegistryCredential is a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry. When this is set:.
      • imagePullCredentialsType must be set to SERVICE_ROLE .
      • images cannot be curated or an Amazon ECR image.
      Returns:
      this

    • registryCredential

      @Stability(Stable) public CfnProject.EnvironmentProperty.Builder registryCredential(CfnProject.RegistryCredentialProperty registryCredential)
      Sets the value of CfnProject.EnvironmentProperty.getRegistryCredential()
      Parameters:
      registryCredential - RegistryCredential is a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry. When this is set:.
      • imagePullCredentialsType must be set to SERVICE_ROLE .
      • images cannot be curated or an Amazon ECR image.
      Returns:
      this

    • build

      @Stability(Stable) public CfnProject.EnvironmentProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnProject.EnvironmentProperty>
      Returns:
      a new instance of CfnProject.EnvironmentProperty
      Throws:
      NullPointerException - if any required attribute was not provided