Package software.amazon.awscdk.cfnpropertymixins.services.codebuild

Interface CfnProjectPropsMixin.EnvironmentProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProjectPropsMixin.EnvironmentProperty.Jsii$Proxy

Enclosing class:

CfnProjectPropsMixin

@Stability(Stable)
public static interface CfnProjectPropsMixin.EnvironmentProperty
extends software.amazon.jsii.JsiiSerializable

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.cfnpropertymixins.services.codebuild.*;
 EnvironmentProperty environmentProperty = EnvironmentProperty.builder()
         .certificate("certificate")
         .computeType("computeType")
         .dockerServer(DockerServerProperty.builder()
                 .computeType("computeType")
                 .securityGroupIds(List.of("securityGroupIds"))
                 .build())
         .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                 .name("name")
                 .type("type")
                 .value("value")
                 .build()))
         .fleet(ProjectFleetProperty.builder()
                 .fleetArn("fleetArn")
                 .build())
         .image("image")
         .imagePullCredentialsType("imagePullCredentialsType")
         .privilegedMode(false)
         .registryCredential(RegistryCredentialProperty.builder()
                 .credential("credential")
                 .credentialProvider("credentialProvider")
                 .build())
         .type("type")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProjectPropsMixin.EnvironmentProperty.Builder	A builder for CfnProjectPropsMixin.EnvironmentProperty
static final class	CfnProjectPropsMixin.EnvironmentProperty.Jsii$Proxy	An implementation for CfnProjectPropsMixin.EnvironmentProperty

Method Summary

Modifier and Type	Method	Description
static CfnProjectPropsMixin.EnvironmentProperty.Builder	builder()
default String	getCertificate()	The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project.
default String	getComputeType()	The type of compute environment.
default Object	getDockerServer()	Returns union: either IResolvable or CfnProjectPropsMixin.DockerServerProperty
default Object	getEnvironmentVariables()	A set of environment variables to make available to builds for this build project.
default Object	getFleet()	Returns union: either IResolvable or CfnProjectPropsMixin.ProjectFleetProperty
default String	getImage()	The image tag or image digest that identifies the Docker image to use for this build project.
default String	getImagePullCredentialsType()	The type of credentials AWS CodeBuild uses to pull images in your build.
default Object	getPrivilegedMode()	Enables running the Docker daemon inside a Docker container.
default Object	getRegistryCredential()	RegistryCredential is a property of the AWS::CodeBuild::Project Environment property that specifies information about credentials that provide access to a private Docker registry.
default String	getType()	The type of build environment to use for related builds.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificate

@Stability(Stable)
@Nullable
default String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-certificate

getComputeType

@Stability(Stable)
@Nullable
default String getComputeType()

The type of compute environment.

This determines the number of CPU cores and memory the build environment uses. Available values include:

• ATTRIBUTE_BASED_COMPUTE : Specify the amount of vCPUs, memory, disk space, and the type of machine.

If you use ATTRIBUTE_BASED_COMPUTE , you must define your attributes by using computeConfiguration . AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the AWS CodeBuild User Guide .

• BUILD_GENERAL1_SMALL : Use up to 4 GiB memory and 2 vCPUs for builds.
• BUILD_GENERAL1_MEDIUM : Use up to 8 GiB memory and 4 vCPUs for builds.
• BUILD_GENERAL1_LARGE : Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
• BUILD_GENERAL1_XLARGE : Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
• BUILD_GENERAL1_2XLARGE : Use up to 144 GiB 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 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_2GB : Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_4GB : Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_8GB : Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_10GB : Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .

If you use BUILD_GENERAL1_SMALL :

• For environment type LINUX_CONTAINER , you can use up to 4 GiB memory and 2 vCPUs for builds.
• For environment type LINUX_GPU_CONTAINER , you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
• For environment type ARM_CONTAINER , you can use up to 4 GiB 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 16 GiB memory and 8 vCPUs for builds.
• For environment type LINUX_GPU_CONTAINER , you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
• For environment type ARM_CONTAINER , you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see On-demand environment types in the AWS CodeBuild User Guide.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-computetype

getDockerServer

@Stability(Stable)
@Nullable
default Object getDockerServer()

Returns union: either IResolvable or CfnProjectPropsMixin.DockerServerProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-dockerserver

getEnvironmentVariables

@Stability(Stable)
@Nullable
default Object getEnvironmentVariables()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnProjectPropsMixin.EnvironmentVariableProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-environmentvariables

getFleet

@Stability(Stable)
@Nullable
default Object getFleet()

Returns union: either IResolvable or CfnProjectPropsMixin.ProjectFleetProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-fleet

getImage

@Stability(Stable)
@Nullable
default 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, 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 .

For more information, see Docker images provided by CodeBuild in the AWS CodeBuild user guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-image

getImagePullCredentialsType

@Stability(Stable)
@Nullable
default 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 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-imagepullcredentialstype

getPrivilegedMode

@Stability(Stable)
@Nullable
default Object 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"

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-privilegedmode

getRegistryCredential

@Stability(Stable)
@Nullable
default Object getRegistryCredential()

RegistryCredential is 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:.

• imagePullCredentialsType must be set to SERVICE_ROLE .
• images cannot be curated or an Amazon ECR image.

Returns union: either IResolvable or CfnProjectPropsMixin.RegistryCredentialProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-registrycredential

getType

@Stability(Stable)
@Nullable
default String getType()

The type of build environment to use for related builds.

If you're using compute fleets during project creation, type will be ignored.

For more information, see Build environment compute types in the AWS CodeBuild user guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-type

builder

@Stability(Stable)
static CfnProjectPropsMixin.EnvironmentProperty.Builder builder()

Returns:

a CfnProjectPropsMixin.EnvironmentProperty.Builder of CfnProjectPropsMixin.EnvironmentProperty