Struct aws_sdk_codebuild::model::ProjectEnvironment [−][src]
#[non_exhaustive]pub struct ProjectEnvironment {
pub type: Option<EnvironmentType>,
pub image: Option<String>,
pub compute_type: Option<ComputeType>,
pub environment_variables: Option<Vec<EnvironmentVariable>>,
pub privileged_mode: Option<bool>,
pub certificate: Option<String>,
pub registry_credential: Option<RegistryCredential>,
pub image_pull_credentials_type: Option<ImagePullCredentialsType>,
}
Expand description
Information about the build environment of the build project.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.type: Option<EnvironmentType>
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 typebuild.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 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).
For more information, see Build environment compute types in the CodeBuild user guide.
image: Option<String>
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:
. 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:
. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use/ @
./ @sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf
For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.
compute_type: Option<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 CodeBuild User Guide.
environment_variables: Option<Vec<EnvironmentVariable>>
A set of environment variables to make available to builds for this build project.
privileged_mode: Option<bool>
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: Option<String>
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.
registry_credential: Option<RegistryCredential>
The credentials for access to a private registry.
image_pull_credentials_type: Option<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.
Implementations
Creates a new builder-style object to manufacture ProjectEnvironment
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for ProjectEnvironment
impl Send for ProjectEnvironment
impl Sync for ProjectEnvironment
impl Unpin for ProjectEnvironment
impl UnwindSafe for ProjectEnvironment
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more