@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ProjectEnvironment extends Object implements Serializable, Cloneable, StructuredPojo
Information about the build environment of the build project.
Constructor and Description |
---|
ProjectEnvironment() |
Modifier and Type | Method and Description |
---|---|
ProjectEnvironment |
clone() |
boolean |
equals(Object obj) |
String |
getCertificate()
The certificate to use with this build project.
|
String |
getComputeType()
Information about the compute resources the build project uses.
|
List<EnvironmentVariable> |
getEnvironmentVariables()
A set of environment variables to make available to builds for this build project.
|
String |
getImage()
The image tag or image digest that identifies the Docker image to use for this build project.
|
String |
getImagePullCredentialsType()
The type of credentials AWS CodeBuild uses to pull images in your build.
|
Boolean |
getPrivilegedMode()
Enables running the Docker daemon inside a Docker container.
|
RegistryCredential |
getRegistryCredential()
The credentials for access to a private registry.
|
String |
getType()
The type of build environment to use for related builds.
|
int |
hashCode() |
Boolean |
isPrivilegedMode()
Enables running the Docker daemon inside a Docker container.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCertificate(String certificate)
The certificate to use with this build project.
|
void |
setComputeType(ComputeType computeType)
Information about the compute resources the build project uses.
|
void |
setComputeType(String computeType)
Information about the compute resources the build project uses.
|
void |
setEnvironmentVariables(Collection<EnvironmentVariable> environmentVariables)
A set of environment variables to make available to builds for this build project.
|
void |
setImage(String image)
The image tag or image digest that identifies the Docker image to use for this build project.
|
void |
setImagePullCredentialsType(ImagePullCredentialsType imagePullCredentialsType)
The type of credentials AWS CodeBuild uses to pull images in your build.
|
void |
setImagePullCredentialsType(String imagePullCredentialsType)
The type of credentials AWS CodeBuild uses to pull images in your build.
|
void |
setPrivilegedMode(Boolean privilegedMode)
Enables running the Docker daemon inside a Docker container.
|
void |
setRegistryCredential(RegistryCredential registryCredential)
The credentials for access to a private registry.
|
void |
setType(EnvironmentType type)
The type of build environment to use for related builds.
|
void |
setType(String type)
The type of build environment to use for related builds.
|
String |
toString()
Returns a string representation of this object.
|
ProjectEnvironment |
withCertificate(String certificate)
The certificate to use with this build project.
|
ProjectEnvironment |
withComputeType(ComputeType computeType)
Information about the compute resources the build project uses.
|
ProjectEnvironment |
withComputeType(String computeType)
Information about the compute resources the build project uses.
|
ProjectEnvironment |
withEnvironmentVariables(Collection<EnvironmentVariable> environmentVariables)
A set of environment variables to make available to builds for this build project.
|
ProjectEnvironment |
withEnvironmentVariables(EnvironmentVariable... environmentVariables)
A set of environment variables to make available to builds for this build project.
|
ProjectEnvironment |
withImage(String image)
The image tag or image digest that identifies the Docker image to use for this build project.
|
ProjectEnvironment |
withImagePullCredentialsType(ImagePullCredentialsType imagePullCredentialsType)
The type of credentials AWS CodeBuild uses to pull images in your build.
|
ProjectEnvironment |
withImagePullCredentialsType(String imagePullCredentialsType)
The type of credentials AWS CodeBuild uses to pull images in your build.
|
ProjectEnvironment |
withPrivilegedMode(Boolean privilegedMode)
Enables running the Docker daemon inside a Docker container.
|
ProjectEnvironment |
withRegistryCredential(RegistryCredential registryCredential)
The credentials for access to a private registry.
|
ProjectEnvironment |
withType(EnvironmentType type)
The type of build environment to use for related builds.
|
ProjectEnvironment |
withType(String type)
The type of build environment to use for related builds.
|
public void setType(String 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).
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).
EnvironmentType
public String getType()
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).
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).
EnvironmentType
public ProjectEnvironment withType(String 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).
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).
EnvironmentType
public void setType(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).
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).
EnvironmentType
public ProjectEnvironment withType(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).
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).
EnvironmentType
public void setImage(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, to specify an image with the tag "latest,"
use registry/repository:latest
.
For an image digest: registry/repository@digest
. For example, to specify an image with the digest
"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use
registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf
.
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, to specify an image with the tag
"latest," use registry/repository:latest
.
For an image digest: registry/repository@digest
. For example, to specify an image with the
digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use
registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf
.
public String getImage()
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, to specify an image with the tag "latest,"
use registry/repository:latest
.
For an image digest: registry/repository@digest
. For example, to specify an image with the digest
"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use
registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf
.
For an image tag: registry/repository:tag
. For example, to specify an image with the tag
"latest," use registry/repository:latest
.
For an image digest: registry/repository@digest
. For example, to specify an image with the
digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use
registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf
.
public ProjectEnvironment withImage(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, to specify an image with the tag "latest,"
use registry/repository:latest
.
For an image digest: registry/repository@digest
. For example, to specify an image with the digest
"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use
registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf
.
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, to specify an image with the tag
"latest," use registry/repository:latest
.
For an image digest: registry/repository@digest
. For example, to specify an image with the
digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use
registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf
.
public void setComputeType(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 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.
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.
ComputeType
public String getComputeType()
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.
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.
ComputeType
public ProjectEnvironment withComputeType(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 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.
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.
ComputeType
public void setComputeType(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.
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.
ComputeType
public ProjectEnvironment withComputeType(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.
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.
ComputeType
public List<EnvironmentVariable> getEnvironmentVariables()
A set of environment variables to make available to builds for this build project.
public void setEnvironmentVariables(Collection<EnvironmentVariable> environmentVariables)
A set of environment variables to make available to builds for this build project.
environmentVariables
- A set of environment variables to make available to builds for this build project.public ProjectEnvironment withEnvironmentVariables(EnvironmentVariable... environmentVariables)
A set of environment variables to make available to builds for this build project.
NOTE: This method appends the values to the existing list (if any). Use
setEnvironmentVariables(java.util.Collection)
or withEnvironmentVariables(java.util.Collection)
if you want to override the existing values.
environmentVariables
- A set of environment variables to make available to builds for this build project.public ProjectEnvironment withEnvironmentVariables(Collection<EnvironmentVariable> environmentVariables)
A set of environment variables to make available to builds for this build project.
environmentVariables
- A set of environment variables to make available to builds for this build project.public void setPrivilegedMode(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"
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"
public Boolean getPrivilegedMode()
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"
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"
public ProjectEnvironment withPrivilegedMode(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"
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"
public Boolean isPrivilegedMode()
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"
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"
public void setCertificate(String certificate)
The certificate to use with this build project.
certificate
- The certificate to use with this build project.public String getCertificate()
The certificate to use with this build project.
public ProjectEnvironment withCertificate(String certificate)
The certificate to use with this build project.
certificate
- The certificate to use with this build project.public void setRegistryCredential(RegistryCredential registryCredential)
The credentials for access to a private registry.
registryCredential
- The credentials for access to a private registry.public RegistryCredential getRegistryCredential()
The credentials for access to a private registry.
public ProjectEnvironment withRegistryCredential(RegistryCredential registryCredential)
The credentials for access to a private registry.
registryCredential
- The credentials for access to a private registry.public void setImagePullCredentialsType(String 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.
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.
ImagePullCredentialsType
public String getImagePullCredentialsType()
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.
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.
ImagePullCredentialsType
public ProjectEnvironment withImagePullCredentialsType(String 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.
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.
ImagePullCredentialsType
public void setImagePullCredentialsType(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.
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.
ImagePullCredentialsType
public ProjectEnvironment withImagePullCredentialsType(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.
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.
ImagePullCredentialsType
public String toString()
toString
in class Object
Object.toString()
public ProjectEnvironment clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.