Interface ProjectEnvironment.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ProjectEnvironment.Builder,
,ProjectEnvironment> SdkBuilder<ProjectEnvironment.Builder,
,ProjectEnvironment> SdkPojo
- Enclosing class:
ProjectEnvironment
-
Method Summary
Modifier and TypeMethodDescriptioncertificate
(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
(String computeType) Information about the compute resources the build project uses.computeType
(ComputeType computeType) Information about the compute resources the build project uses.environmentVariables
(Collection<EnvironmentVariable> environmentVariables) A set of environment variables to make available to builds for this build project.environmentVariables
(Consumer<EnvironmentVariable.Builder>... environmentVariables) A set of environment variables to make available to builds for this build project.environmentVariables
(EnvironmentVariable... environmentVariables) A set of environment variables to make available to builds for this build project.default ProjectEnvironment.Builder
fleet
(Consumer<ProjectFleet.Builder> fleet) A ProjectFleet object to use for this build project.fleet
(ProjectFleet fleet) A ProjectFleet object to use for this build project.The image tag or image digest that identifies the Docker image to use for this build project.imagePullCredentialsType
(String imagePullCredentialsType) The type of credentials CodeBuild uses to pull images in your build.imagePullCredentialsType
(ImagePullCredentialsType imagePullCredentialsType) The type of credentials CodeBuild uses to pull images in your build.privilegedMode
(Boolean privilegedMode) Enables running the Docker daemon inside a Docker container.default ProjectEnvironment.Builder
registryCredential
(Consumer<RegistryCredential.Builder> registryCredential) The credentials for access to a private registry.registryCredential
(RegistryCredential registryCredential) The credentials for access to a private registry.The type of build environment to use for related builds.type
(EnvironmentType type) The type of build environment to use for related builds.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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 types
ARM_LAMBDA_CONTAINER
andLINUX_LAMBDA_CONTAINER
are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).
-
The environment types
WINDOWS_CONTAINER
andWINDOWS_SERVER_2019_CONTAINER
are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).
If you're using compute fleets during project creation,
type
will be ignored.For more information, see Build environment compute types in the CodeBuild user guide.
- Parameters:
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
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 types
ARM_LAMBDA_CONTAINER
andLINUX_LAMBDA_CONTAINER
are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).
-
The environment types
WINDOWS_CONTAINER
andWINDOWS_SERVER_2019_CONTAINER
are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).
If you're using compute fleets during project creation,
type
will be ignored.For more information, see Build environment compute types in the CodeBuild user guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
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 types
ARM_LAMBDA_CONTAINER
andLINUX_LAMBDA_CONTAINER
are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).
-
The environment types
WINDOWS_CONTAINER
andWINDOWS_SERVER_2019_CONTAINER
are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).
If you're using compute fleets during project creation,
type
will be ignored.For more information, see Build environment compute types in the CodeBuild user guide.
- Parameters:
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
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 types
ARM_LAMBDA_CONTAINER
andLINUX_LAMBDA_CONTAINER
are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).
-
The environment types
WINDOWS_CONTAINER
andWINDOWS_SERVER_2019_CONTAINER
are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).
If you're using compute fleets during project creation,
type
will be ignored.For more information, see Build environment compute types in the CodeBuild user guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 beaws/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
.
For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.
- Parameters:
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 beaws/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
.
For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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_XLARGE
: Use up to 70 GB memory and 36 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. -
BUILD_LAMBDA_1GB
: Use up to 1 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_2GB
: Use up to 2 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_4GB
: Use up to 4 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_8GB
: Use up to 8 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_10GB
: Use up to 10 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
.
If you use
BUILD_GENERAL1_SMALL
:-
For environment type
LINUX_CONTAINER
, you can use up to 3 GB memory and 2 vCPUs for builds. -
For environment type
LINUX_GPU_CONTAINER
, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. -
For environment type
ARM_CONTAINER
, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
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.
If you're using compute fleets during project creation,
computeType
will be ignored.For more information, see Build Environment Compute Types in the CodeBuild User Guide.
- 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 16 GB memory and 8 vCPUs for builds, depending on your environment type. -
BUILD_GENERAL1_XLARGE
: Use up to 70 GB memory and 36 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. -
BUILD_LAMBDA_1GB
: Use up to 1 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_2GB
: Use up to 2 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_4GB
: Use up to 4 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_8GB
: Use up to 8 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_10GB
: Use up to 10 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
.
If you use
BUILD_GENERAL1_SMALL
:-
For environment type
LINUX_CONTAINER
, you can use up to 3 GB memory and 2 vCPUs for builds. -
For environment type
LINUX_GPU_CONTAINER
, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. -
For environment type
ARM_CONTAINER
, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
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.
If you're using compute fleets during project creation,
computeType
will be ignored.For more information, see Build Environment Compute Types in the CodeBuild User Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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_XLARGE
: Use up to 70 GB memory and 36 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. -
BUILD_LAMBDA_1GB
: Use up to 1 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_2GB
: Use up to 2 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_4GB
: Use up to 4 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_8GB
: Use up to 8 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_10GB
: Use up to 10 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
.
If you use
BUILD_GENERAL1_SMALL
:-
For environment type
LINUX_CONTAINER
, you can use up to 3 GB memory and 2 vCPUs for builds. -
For environment type
LINUX_GPU_CONTAINER
, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. -
For environment type
ARM_CONTAINER
, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
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.
If you're using compute fleets during project creation,
computeType
will be ignored.For more information, see Build Environment Compute Types in the CodeBuild User Guide.
- 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 16 GB memory and 8 vCPUs for builds, depending on your environment type. -
BUILD_GENERAL1_XLARGE
: Use up to 70 GB memory and 36 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. -
BUILD_LAMBDA_1GB
: Use up to 1 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_2GB
: Use up to 2 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_4GB
: Use up to 4 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_8GB
: Use up to 8 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
. -
BUILD_LAMBDA_10GB
: Use up to 10 GB memory for builds. Only available for environment typeLINUX_LAMBDA_CONTAINER
andARM_LAMBDA_CONTAINER
.
If you use
BUILD_GENERAL1_SMALL
:-
For environment type
LINUX_CONTAINER
, you can use up to 3 GB memory and 2 vCPUs for builds. -
For environment type
LINUX_GPU_CONTAINER
, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. -
For environment type
ARM_CONTAINER
, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
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.
If you're using compute fleets during project creation,
computeType
will be ignored.For more information, see Build Environment Compute Types in the CodeBuild User Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
fleet
A ProjectFleet object to use for this build project.
- Parameters:
fleet
- A ProjectFleet object to use for this build project.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fleet
A ProjectFleet object to use for this build project.
This is a convenience method that creates an instance of theProjectFleet.Builder
avoiding the need to create one manually viaProjectFleet.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofleet(ProjectFleet)
.- Parameters:
fleet
- a consumer that will call methods onProjectFleet.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 method that creates an instance of theEnvironmentVariable.Builder
avoiding the need to create one manually viaEnvironmentVariable.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenvironmentVariables(List<EnvironmentVariable>)
.- Parameters:
environmentVariables
- a consumer that will call methods onEnvironmentVariable.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 totimeout
:- 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"
- Parameters:
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 isfalse
.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 totimeout
:- 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:
- Returns a reference to this object so that method calls can be chained together.
-
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 CodeBuild User Guide.
- Parameters:
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 CodeBuild User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
registryCredential
The credentials for access to a private registry.
- Parameters:
registryCredential
- The credentials for access to a private registry.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
registryCredential
default ProjectEnvironment.Builder registryCredential(Consumer<RegistryCredential.Builder> registryCredential) The credentials for access to a private registry.
This is a convenience method that creates an instance of theRegistryCredential.Builder
avoiding the need to create one manually viaRegistryCredential.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toregistryCredential(RegistryCredential)
.- Parameters:
registryCredential
- a consumer that will call methods onRegistryCredential.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
imagePullCredentialsType
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
-
CODEBUILD
specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. -
SERVICE_ROLE
specifies that 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 CodeBuild curated image, you must use CODEBUILD credentials.
- Parameters:
imagePullCredentialsType
- The type of credentials CodeBuild uses to pull images in your build. There are two valid values:-
CODEBUILD
specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. -
SERVICE_ROLE
specifies that 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 CodeBuild curated image, you must use CODEBUILD credentials.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
imagePullCredentialsType
ProjectEnvironment.Builder imagePullCredentialsType(ImagePullCredentialsType imagePullCredentialsType) The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
-
CODEBUILD
specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. -
SERVICE_ROLE
specifies that 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 CodeBuild curated image, you must use CODEBUILD credentials.
- Parameters:
imagePullCredentialsType
- The type of credentials CodeBuild uses to pull images in your build. There are two valid values:-
CODEBUILD
specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. -
SERVICE_ROLE
specifies that 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 CodeBuild curated image, you must use CODEBUILD credentials.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-