Package software.amazon.awscdk.cfnpropertymixins.services.codebuild

Class CfnProjectPropsMixin.EnvironmentProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.codebuild.CfnProjectPropsMixin.EnvironmentProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnProjectPropsMixin.EnvironmentProperty>

Enclosing interface:

CfnProjectPropsMixin.EnvironmentProperty

@Stability(Stable)
public static final class CfnProjectPropsMixin.EnvironmentProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnProjectPropsMixin.EnvironmentProperty>

A builder for CfnProjectPropsMixin.EnvironmentProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnProjectPropsMixin.EnvironmentProperty	build()	Builds the configured instance.
CfnProjectPropsMixin.EnvironmentProperty.Builder	certificate(String certificate)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getCertificate()
CfnProjectPropsMixin.EnvironmentProperty.Builder	computeType(String computeType)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getComputeType()
CfnProjectPropsMixin.EnvironmentProperty.Builder	dockerServer(CfnProjectPropsMixin.DockerServerProperty dockerServer)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getDockerServer()
CfnProjectPropsMixin.EnvironmentProperty.Builder	dockerServer(IResolvable dockerServer)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getDockerServer()
CfnProjectPropsMixin.EnvironmentProperty.Builder	environmentVariables(List<? extends Object> environmentVariables)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getEnvironmentVariables()
CfnProjectPropsMixin.EnvironmentProperty.Builder	environmentVariables(IResolvable environmentVariables)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getEnvironmentVariables()
CfnProjectPropsMixin.EnvironmentProperty.Builder	fleet(CfnProjectPropsMixin.ProjectFleetProperty fleet)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getFleet()
CfnProjectPropsMixin.EnvironmentProperty.Builder	fleet(IResolvable fleet)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getFleet()
CfnProjectPropsMixin.EnvironmentProperty.Builder	hostKernel(String hostKernel)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getHostKernel()
CfnProjectPropsMixin.EnvironmentProperty.Builder	image(String image)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getImage()
CfnProjectPropsMixin.EnvironmentProperty.Builder	imagePullCredentialsType(String imagePullCredentialsType)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getImagePullCredentialsType()
CfnProjectPropsMixin.EnvironmentProperty.Builder	privilegedMode(Boolean privilegedMode)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getPrivilegedMode()
CfnProjectPropsMixin.EnvironmentProperty.Builder	privilegedMode(IResolvable privilegedMode)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getPrivilegedMode()
CfnProjectPropsMixin.EnvironmentProperty.Builder	registryCredential(CfnProjectPropsMixin.RegistryCredentialProperty registryCredential)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getRegistryCredential()
CfnProjectPropsMixin.EnvironmentProperty.Builder	registryCredential(IResolvable registryCredential)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getRegistryCredential()
CfnProjectPropsMixin.EnvironmentProperty.Builder	type(String type)	Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

certificate

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder certificate(String certificate)

Sets the value of CfnProjectPropsMixin.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

computeType

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder computeType(String computeType)

Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getComputeType()

Parameters:

computeType - The type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values include:

• ATTRIBUTE_BASED_COMPUTE : Specify the amount of vCPUs, memory, disk space, and the type of machine.

If you use ATTRIBUTE_BASED_COMPUTE , you must define your attributes by using computeConfiguration . AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the AWS CodeBuild User Guide .

• BUILD_GENERAL1_SMALL : Use up to 4 GiB memory and 2 vCPUs for builds.
• BUILD_GENERAL1_MEDIUM : Use up to 8 GiB memory and 4 vCPUs for builds.
• BUILD_GENERAL1_LARGE : Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
• BUILD_GENERAL1_XLARGE : Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
• BUILD_GENERAL1_2XLARGE : Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
• BUILD_LAMBDA_1GB : Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_2GB : Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_4GB : Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_8GB : Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_10GB : Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .

If you use BUILD_GENERAL1_SMALL :

• For environment type LINUX_CONTAINER , you can use up to 4 GiB memory and 2 vCPUs for builds.
• For environment type LINUX_GPU_CONTAINER , you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
• For environment type ARM_CONTAINER , you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.

If you use BUILD_GENERAL1_LARGE :

• For environment type LINUX_CONTAINER , you can use up to 16 GiB memory and 8 vCPUs for builds.
• For environment type LINUX_GPU_CONTAINER , you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
• For environment type ARM_CONTAINER , you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see On-demand environment types in the AWS CodeBuild User Guide.

Returns:

this

dockerServer

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder dockerServer(IResolvable dockerServer)

Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getDockerServer()

Parameters:

dockerServer - the value to be set.

Returns:

this

dockerServer

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder dockerServer(CfnProjectPropsMixin.DockerServerProperty dockerServer)

Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getDockerServer()

Parameters:

dockerServer - the value to be set.

Returns:

this

environmentVariables

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder environmentVariables(IResolvable environmentVariables)

Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getEnvironmentVariables()

Parameters:

environmentVariables - A set of environment variables to make available to builds for this build project.

Returns:

this

environmentVariables

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder environmentVariables(List<? extends Object> environmentVariables)

Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getEnvironmentVariables()

Parameters:

environmentVariables - A set of environment variables to make available to builds for this build project.

Returns:

this

fleet

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder fleet(IResolvable fleet)

Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getFleet()

Parameters:

fleet - the value to be set.

Returns:

this

fleet

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder fleet(CfnProjectPropsMixin.ProjectFleetProperty fleet)

Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getFleet()

Parameters:

fleet - the value to be set.

Returns:

this

hostKernel

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder hostKernel(String hostKernel)

Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getHostKernel()

Parameters:

hostKernel - the value to be set.

Returns:

this

image

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder image(String image)

Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getImage()

Parameters:

image - The image tag or image digest that identifies the Docker image to use for this build project. 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

imagePullCredentialsType

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder imagePullCredentialsType(String imagePullCredentialsType)

Sets the value of CfnProjectPropsMixin.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 CfnProjectPropsMixin.EnvironmentProperty.Builder privilegedMode(Boolean privilegedMode)

Sets the value of CfnProjectPropsMixin.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 CfnProjectPropsMixin.EnvironmentProperty.Builder privilegedMode(IResolvable privilegedMode)

Sets the value of CfnProjectPropsMixin.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 CfnProjectPropsMixin.EnvironmentProperty.Builder registryCredential(IResolvable registryCredential)

Sets the value of CfnProjectPropsMixin.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 CfnProjectPropsMixin.EnvironmentProperty.Builder registryCredential(CfnProjectPropsMixin.RegistryCredentialProperty registryCredential)

Sets the value of CfnProjectPropsMixin.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

type

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty.Builder type(String type)

Sets the value of CfnProjectPropsMixin.EnvironmentProperty.getType()

Parameters:

type - The type of build environment to use for related builds.

If you're using compute fleets during project creation, type will be ignored.

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

Returns:

this

build

@Stability(Stable)
public CfnProjectPropsMixin.EnvironmentProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnProjectPropsMixin.EnvironmentProperty>

Returns:

a new instance of CfnProjectPropsMixin.EnvironmentProperty

Throws:

NullPointerException - if any required attribute was not provided