Package software.amazon.awscdk.services.codebuild

Class CfnProject.EnvironmentProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codebuild.CfnProject.EnvironmentProperty.Jsii$Proxy

All Implemented Interfaces:

CfnProject.EnvironmentProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnProject.EnvironmentProperty

@Stability(Stable)
@Internal
public static final class CfnProject.EnvironmentProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnProject.EnvironmentProperty

An implementation for CfnProject.EnvironmentProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.CfnProject.EnvironmentProperty

CfnProject.EnvironmentProperty.Builder, CfnProject.EnvironmentProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnProject.EnvironmentProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnProject.EnvironmentProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getCertificate()	The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project.
final String	getComputeType()	The type of compute environment.
final Object	getEnvironmentVariables()	A set of environment variables to make available to builds for this build project.
final Object	getFleet()
final String	getImage()	The image tag or image digest that identifies the Docker image to use for this build project.
final String	getImagePullCredentialsType()	The type of credentials AWS CodeBuild uses to pull images in your build.
final Object	getPrivilegedMode()	Enables running the Docker daemon inside a Docker container.
final 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.
final String	getType()	The type of build environment to use for related builds.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnProject.EnvironmentProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnProject.EnvironmentProperty.Builder.

Method Details

getComputeType

public final String getComputeType()

Description copied from interface: CfnProject.EnvironmentProperty

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 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 type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_2GB : Use up to 2 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_4GB : Use up to 4 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_8GB : Use up to 8 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .
• BUILD_LAMBDA_10GB : Use up to 10 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER .

For more information, see Build Environment Compute Types in the AWS CodeBuild User Guide.

Specified by:

getComputeType in interface CfnProject.EnvironmentProperty

See Also:

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

getImage

public final String getImage()

Description copied from interface: CfnProject.EnvironmentProperty

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 .

Specified by:

getImage in interface CfnProject.EnvironmentProperty

See Also:

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

getType

public final String getType()

Description copied from interface: CfnProject.EnvironmentProperty

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 and LINUX_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 and WINDOWS_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 AWS CodeBuild user guide .

Specified by:

getType in interface CfnProject.EnvironmentProperty

See Also:

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

getCertificate

public final String getCertificate()

Description copied from interface: CfnProject.EnvironmentProperty

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 .

Specified by:

getCertificate in interface CfnProject.EnvironmentProperty

See Also:

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

getEnvironmentVariables

public final Object getEnvironmentVariables()

Description copied from interface: CfnProject.EnvironmentProperty

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

Specified by:

getEnvironmentVariables in interface CfnProject.EnvironmentProperty

See Also:

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

getFleet

public final Object getFleet()

Specified by:

getFleet in interface CfnProject.EnvironmentProperty

See Also:

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

getImagePullCredentialsType

public final String getImagePullCredentialsType()

Description copied from interface: CfnProject.EnvironmentProperty

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.

Specified by:

getImagePullCredentialsType in interface CfnProject.EnvironmentProperty

See Also:

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

getPrivilegedMode

public final Object getPrivilegedMode()

Description copied from interface: CfnProject.EnvironmentProperty

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"

Specified by:

getPrivilegedMode in interface CfnProject.EnvironmentProperty

See Also:

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

getRegistryCredential

public final Object getRegistryCredential()

Description copied from interface: CfnProject.EnvironmentProperty

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.

Specified by:

getRegistryCredential in interface CfnProject.EnvironmentProperty

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object