software.amazon.awssdk.services.codebuild.model

Interface ProjectEnvironment.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ProjectEnvironment.Builder,ProjectEnvironment>, SdkBuilder<ProjectEnvironment.Builder,ProjectEnvironment>, SdkPojo

Enclosing class:

ProjectEnvironment

public static interface ProjectEnvironment.Builder
extends SdkPojo, CopyableBuilder<ProjectEnvironment.Builder,ProjectEnvironment>

Method Summary

Modifier and Type	Method and Description
ProjectEnvironment.Builder	certificate(String certificate) The certificate to use with this build project.
ProjectEnvironment.Builder	computeType(ComputeType computeType) Information about the compute resources the build project uses.
ProjectEnvironment.Builder	computeType(String computeType) Information about the compute resources the build project uses.
ProjectEnvironment.Builder	environmentVariables(Collection<EnvironmentVariable> environmentVariables) A set of environment variables to make available to builds for this build project.
ProjectEnvironment.Builder	environmentVariables(Consumer<EnvironmentVariable.Builder>... environmentVariables) A set of environment variables to make available to builds for this build project.
ProjectEnvironment.Builder	environmentVariables(EnvironmentVariable... environmentVariables) A set of environment variables to make available to builds for this build project.
ProjectEnvironment.Builder	image(String image) The ID of the Docker image to use for this build project.
ProjectEnvironment.Builder	privilegedMode(Boolean privilegedMode) Enables running the Docker daemon inside a Docker container.
ProjectEnvironment.Builder	type(EnvironmentType type) The type of build environment to use for related builds.
ProjectEnvironment.Builder	type(String type) The type of build environment to use for related builds.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

type

ProjectEnvironment.Builder type(String type)

The type of build environment to use for related builds.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnvironmentType, EnvironmentType

type

ProjectEnvironment.Builder type(EnvironmentType type)

The type of build environment to use for related builds.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnvironmentType, EnvironmentType

image

ProjectEnvironment.Builder image(String image)

The ID of the Docker image to use for this build project.

Parameters:

image - The ID of the Docker image to use for this build project.

Returns:

Returns a reference to this object so that method calls can be chained together.

computeType

ProjectEnvironment.Builder computeType(String computeType)

Information about the compute resources the build project 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.

Parameters:

computeType - Information about the compute resources the build project 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComputeType, ComputeType

computeType

ProjectEnvironment.Builder computeType(ComputeType computeType)

Information about the compute resources the build project 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.

Parameters:

computeType - Information about the compute resources the build project 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComputeType, ComputeType

environmentVariables

ProjectEnvironment.Builder environmentVariables(Collection<EnvironmentVariable> environmentVariables)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

environmentVariables

ProjectEnvironment.Builder environmentVariables(EnvironmentVariable... environmentVariables)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

environmentVariables

ProjectEnvironment.Builder environmentVariables(Consumer<EnvironmentVariable.Builder>... environmentVariables)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #environmentVariables(List).

Parameters:

environmentVariables - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#environmentVariables(List)

privilegedMode

ProjectEnvironment.Builder privilegedMode(Boolean privilegedMode)

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

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, 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 15 -t sh -c "until docker info; do echo .; sleep 1; done"

Parameters:

privilegedMode - Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

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, 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 15 -t sh -c "until docker info; do echo .; sleep 1; done"

Returns:

Returns a reference to this object so that method calls can be chained together.

certificate

ProjectEnvironment.Builder certificate(String certificate)

The certificate to use with this build project.

Parameters:

certificate - The certificate to use with this build project.

Returns:

Returns a reference to this object so that method calls can be chained together.