Interface CfnProject.EnvironmentProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnProject.EnvironmentProperty.Jsii$Proxy
- Enclosing class:
CfnProject
Environment is a property of the AWS::CodeBuild::Project resource that specifies the environment for an AWS CodeBuild project.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codebuild.*;
EnvironmentProperty environmentProperty = EnvironmentProperty.builder()
.computeType("computeType")
.image("image")
.type("type")
// the properties below are optional
.certificate("certificate")
.environmentVariables(List.of(EnvironmentVariableProperty.builder()
.name("name")
.value("value")
// the properties below are optional
.type("type")
.build()))
.fleet(ProjectFleetProperty.builder()
.fleetArn("fleetArn")
.build())
.imagePullCredentialsType("imagePullCredentialsType")
.privilegedMode(false)
.registryCredential(RegistryCredentialProperty.builder()
.credential("credential")
.credentialProvider("credentialProvider")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnProject.EnvironmentPropertystatic final classAn implementation forCfnProject.EnvironmentProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project.The type of compute environment.default ObjectA set of environment variables to make available to builds for this build project.default ObjectgetFleet()getImage()The image tag or image digest that identifies the Docker image to use for this build project.default StringThe type of credentials AWS CodeBuild uses to pull images in your build.default ObjectEnables running the Docker daemon inside a Docker container.default ObjectRegistryCredentialis a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry.getType()The type of build environment to use for related builds.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getComputeType
The type of compute environment.This determines the number of CPU cores and memory the build environment uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.
For more information, see Build Environment Compute Types in the AWS CodeBuild User Guide.
- See Also:
-
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, 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 AWS CodeBuild user guide .
- See Also:
- For an image tag:
-
getType
The type of build environment to use for related builds.- The environment type
ARM_CONTAINERis 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_CONTAINERis 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_CONTAINERis 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_CONTAINERandLINUX_LAMBDA_CONTAINERare 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_CONTAINERandWINDOWS_SERVER_2019_CONTAINERare 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,
typewill be ignored.For more information, see Build environment compute types in the AWS CodeBuild user guide .
- See Also:
- The environment type
-
getCertificate
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 .
- See Also:
-
getEnvironmentVariables
A set of environment variables to make available to builds for this build project.- See Also:
-
getFleet
- See Also:
-
getImagePullCredentialsType
The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:.CODEBUILDspecifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal.SERVICE_ROLEspecifies 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:
-
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
-targument 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"- See Also:
-
getRegistryCredential
RegistryCredentialis a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry. When this is set:.imagePullCredentialsTypemust be set toSERVICE_ROLE.- images cannot be curated or an Amazon ECR image.
- See Also:
-
builder
-