software.amazon.awssdk.services.codebuild.model

Class ProjectEnvironment

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ProjectEnvironment.Builder,ProjectEnvironment>

@Generated(value="software.amazon.awssdk:codegen")
public final class ProjectEnvironment
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ProjectEnvironment.Builder,ProjectEnvironment>

Information about the build environment of the build project.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProjectEnvironment.Builder

Method Summary

Modifier and Type	Method and Description
static ProjectEnvironment.Builder	builder()
String	certificate() The certificate to use with this build project.
ComputeType	computeType() Information about the compute resources the build project uses.
String	computeTypeAsString() Information about the compute resources the build project uses.
List<EnvironmentVariable>	environmentVariables() A set of environment variables to make available to builds for this build project.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	image() The ID of the Docker image to use for this build project.
Boolean	privilegedMode() Enables running the Docker daemon inside a Docker container.
List<SdkField<?>>	sdkFields()
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()
EnvironmentType	type() The type of build environment to use for related builds.
String	typeAsString() The type of build environment to use for related builds.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

type

public EnvironmentType type()

The type of build environment to use for related builds.

If the service returns an enum value that is not available in the current SDK version, type will return EnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of build environment to use for related builds.

See Also:

EnvironmentType

typeAsString

public String typeAsString()

The type of build environment to use for related builds.

If the service returns an enum value that is not available in the current SDK version, type will return EnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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 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.

If the service returns an enum value that is not available in the current SDK version, computeType will return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeTypeAsString().

Returns:

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.

See Also:

ComputeType

computeTypeAsString

public String computeTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, computeType will return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeTypeAsString().

Returns:

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.

See Also:

ComputeType

environmentVariables

public List<EnvironmentVariable> environmentVariables()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

privilegedMode

public 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"

Returns:

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"

certificate

public String certificate()

The certificate to use with this build project.

Returns:

The certificate to use with this build project.

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.