Package software.amazon.awssdk.services.codebuild.model

Class ProjectEnvironment

java.lang.Object

software.amazon.awssdk.services.codebuild.model.ProjectEnvironment

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<ProjectEnvironment.Builder,ProjectEnvironment>

@Generated("software.amazon.awssdk:codegen")
public class ProjectEnvironment
extends Object
implements StructuredPojo, ToCopyableBuilder<ProjectEnvironment.Builder,ProjectEnvironment>

Information about the build environment of the build project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProjectEnvironment.Builder

Method Summary

Modifier and Type	Method	Description
static ProjectEnvironment.Builder	builder()
String	computeType()	Information about the compute resources the build project will use.
List<EnvironmentVariable>	environmentVariables()	A set of environment variables to make available to builds for this build project.
boolean	equals(Object obj)
int	hashCode()
String	image()	The ID of the Docker image to use for this build project.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
Boolean	privilegedMode()	If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default).
static Class<? extends ProjectEnvironment.Builder>	serializableBuilderClass()
ProjectEnvironment.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	The type of build environment to use for related builds.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

type

public String type()

The type of build environment to use for related builds.

Returns:

The type of build environment to use for related builds.

See Also:

EnvironmentType

image

public String image()

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

Returns:

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

computeType

public String computeType()

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

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

See Also:

ComputeType

environmentVariables

public List<EnvironmentVariable> environmentVariables()

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

Returns:

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

privilegedMode

public Boolean privilegedMode()

If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). 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. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=vfs& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

Returns:

If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). 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. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=vfs& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"

toBuilder

public ProjectEnvironment.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ProjectEnvironment.Builder,ProjectEnvironment>

Returns:

a builder for type T

builder

public static ProjectEnvironment.Builder builder()

serializableBuilderClass

public static Class<? extends ProjectEnvironment.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.