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 ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEnvironmentVariables() Returns true if the EnvironmentVariables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	image() The image tag or image digest that identifies the Docker image to use for this build project.
ImagePullCredentialsType	imagePullCredentialsType() The type of credentials AWS CodeBuild uses to pull images in your build.
String	imagePullCredentialsTypeAsString() The type of credentials AWS CodeBuild uses to pull images in your build.
Boolean	privilegedMode() Enables running the Docker daemon inside a Docker container.
RegistryCredential	registryCredential() The credentials for access to a private registry.
List<SdkField<?>>	sdkFields()
static Class<? extends ProjectEnvironment.Builder>	serializableBuilderClass()
ProjectEnvironment.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

type

public final EnvironmentType type()

The type of build environment to use for related builds.

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

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.

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

See Also:

EnvironmentType

typeAsString

public final String typeAsString()

The type of build environment to use for related builds.

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

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.

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

See Also:

EnvironmentType

image

public final String 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 .

Returns:

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 .

computeType

public final 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 16 GB memory and 8 vCPUs for builds, depending on your environment type.

• BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.

If you use BUILD_GENERAL1_LARGE:

• For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.

• For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

• For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.

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

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 16 GB memory and 8 vCPUs for builds, depending on your environment type.

• BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.

If you use BUILD_GENERAL1_LARGE:

• For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.

• For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

• For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.

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

See Also:

ComputeType

computeTypeAsString

public final 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 16 GB memory and 8 vCPUs for builds, depending on your environment type.

• BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.

If you use BUILD_GENERAL1_LARGE:

• For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.

• For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

• For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.

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

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 16 GB memory and 8 vCPUs for builds, depending on your environment type.

• BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.

If you use BUILD_GENERAL1_LARGE:

• For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.

• For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

• For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.

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

See Also:

ComputeType

hasEnvironmentVariables

public final boolean hasEnvironmentVariables()

Returns true if the EnvironmentVariables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

environmentVariables

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

You can use hasEnvironmentVariables() to see if a value was sent in this field.

Returns:

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

privilegedMode

public final Boolean 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:

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"

certificate

public final String 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:

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.

registryCredential

public final RegistryCredential registryCredential()

The credentials for access to a private registry.

Returns:

The credentials for access to a private registry.

imagePullCredentialsType

public final ImagePullCredentialsType 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's 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.

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

Returns:

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

See Also:

ImagePullCredentialsType

imagePullCredentialsTypeAsString

public final String imagePullCredentialsTypeAsString()

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

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

Returns:

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

See Also:

ImagePullCredentialsType

toBuilder

public ProjectEnvironment.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProjectEnvironment.Builder,ProjectEnvironment>

builder

public static ProjectEnvironment.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo