com.amazonaws.services.codebuild.model

Class ProjectEnvironment

java.lang.Object

com.amazonaws.services.codebuild.model.ProjectEnvironment

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProjectEnvironment
extends Object
implements Serializable, Cloneable, StructuredPojo

Information about the build environment of the build project.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProjectEnvironment()

Method Summary

Modifier and Type	Method and Description
ProjectEnvironment	clone()
boolean	equals(Object obj)
String	getCertificate() The certificate to use with this build project.
String	getComputeType() Information about the compute resources the build project uses.
List<EnvironmentVariable>	getEnvironmentVariables() A set of environment variables to make available to builds for this build project.
String	getImage() The image tag or image digest that identifies the Docker image to use for this build project.
String	getImagePullCredentialsType() The type of credentials AWS CodeBuild uses to pull images in your build.
Boolean	getPrivilegedMode() Enables running the Docker daemon inside a Docker container.
RegistryCredential	getRegistryCredential() The credentials for access to a private registry.
String	getType() The type of build environment to use for related builds.
int	hashCode()
Boolean	isPrivilegedMode() Enables running the Docker daemon inside a Docker container.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCertificate(String certificate) The certificate to use with this build project.
void	setComputeType(ComputeType computeType) Information about the compute resources the build project uses.
void	setComputeType(String computeType) Information about the compute resources the build project uses.
void	setEnvironmentVariables(Collection<EnvironmentVariable> environmentVariables) A set of environment variables to make available to builds for this build project.
void	setImage(String image) The image tag or image digest that identifies the Docker image to use for this build project.
void	setImagePullCredentialsType(ImagePullCredentialsType imagePullCredentialsType) The type of credentials AWS CodeBuild uses to pull images in your build.
void	setImagePullCredentialsType(String imagePullCredentialsType) The type of credentials AWS CodeBuild uses to pull images in your build.
void	setPrivilegedMode(Boolean privilegedMode) Enables running the Docker daemon inside a Docker container.
void	setRegistryCredential(RegistryCredential registryCredential) The credentials for access to a private registry.
void	setType(EnvironmentType type) The type of build environment to use for related builds.
void	setType(String type) The type of build environment to use for related builds.
String	toString() Returns a string representation of this object.
ProjectEnvironment	withCertificate(String certificate) The certificate to use with this build project.
ProjectEnvironment	withComputeType(ComputeType computeType) Information about the compute resources the build project uses.
ProjectEnvironment	withComputeType(String computeType) Information about the compute resources the build project uses.
ProjectEnvironment	withEnvironmentVariables(Collection<EnvironmentVariable> environmentVariables) A set of environment variables to make available to builds for this build project.
ProjectEnvironment	withEnvironmentVariables(EnvironmentVariable... environmentVariables) A set of environment variables to make available to builds for this build project.
ProjectEnvironment	withImage(String image) The image tag or image digest that identifies the Docker image to use for this build project.
ProjectEnvironment	withImagePullCredentialsType(ImagePullCredentialsType imagePullCredentialsType) The type of credentials AWS CodeBuild uses to pull images in your build.
ProjectEnvironment	withImagePullCredentialsType(String imagePullCredentialsType) The type of credentials AWS CodeBuild uses to pull images in your build.
ProjectEnvironment	withPrivilegedMode(Boolean privilegedMode) Enables running the Docker daemon inside a Docker container.
ProjectEnvironment	withRegistryCredential(RegistryCredential registryCredential) The credentials for access to a private registry.
ProjectEnvironment	withType(EnvironmentType type) The type of build environment to use for related builds.
ProjectEnvironment	withType(String type) The type of build environment to use for related builds.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProjectEnvironment

public ProjectEnvironment()

Method Detail

setType

public void setType(String type)

The type of build environment to use for related builds.

Parameters:

type - The type of build environment to use for related builds.

See Also:

EnvironmentType

getType

public String getType()

The type of build environment to use for related builds.

Returns:

The type of build environment to use for related builds.

See Also:

EnvironmentType

withType

public ProjectEnvironment withType(String type)

The type of build environment to use for related builds.

Parameters:

type - The type of build environment to use for related builds.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnvironmentType

setType

public void setType(EnvironmentType type)

The type of build environment to use for related builds.

Parameters:

type - The type of build environment to use for related builds.

See Also:

EnvironmentType

withType

public ProjectEnvironment withType(EnvironmentType type)

The type of build environment to use for related builds.

Parameters:

type - The type of build environment to use for related builds.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EnvironmentType

setImage

public void setImage(String 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, to specify an image with the tag "latest," use registry/repository:latest.

• For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.

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, to specify an image with the tag "latest," use registry/repository:latest.

• For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.

getImage

public 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, to specify an image with the tag "latest," use registry/repository:latest.

• For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.

Returns:

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, to specify an image with the tag "latest," use registry/repository:latest.

• For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.

withImage

public ProjectEnvironment withImage(String 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, to specify an image with the tag "latest," use registry/repository:latest.

• For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.

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, to specify an image with the tag "latest," use registry/repository:latest.

• For an image digest: registry/repository@digest. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.

Returns:

Returns a reference to this object so that method calls can be chained together.

setComputeType

public void setComputeType(String 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 15 GB memory and 8 vCPUs for builds.

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 15 GB memory and 8 vCPUs for builds.

See Also:

ComputeType

getComputeType

public String getComputeType()

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 15 GB memory and 8 vCPUs for builds.

Returns:

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 15 GB memory and 8 vCPUs for builds.

See Also:

ComputeType

withComputeType

public ProjectEnvironment withComputeType(String 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 15 GB memory and 8 vCPUs for builds.

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 15 GB memory and 8 vCPUs for builds.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComputeType

setComputeType

public void setComputeType(ComputeType 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 15 GB memory and 8 vCPUs for builds.

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 15 GB memory and 8 vCPUs for builds.

See Also:

ComputeType

withComputeType

public ProjectEnvironment withComputeType(ComputeType 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 15 GB memory and 8 vCPUs for builds.

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 15 GB memory and 8 vCPUs for builds.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComputeType

getEnvironmentVariables

public List<EnvironmentVariable> getEnvironmentVariables()

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

Returns:

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

setEnvironmentVariables

public void setEnvironmentVariables(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.

withEnvironmentVariables

public ProjectEnvironment withEnvironmentVariables(EnvironmentVariable... environmentVariables)

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

NOTE: This method appends the values to the existing list (if any). Use setEnvironmentVariables(java.util.Collection) or withEnvironmentVariables(java.util.Collection) if you want to override the existing values.

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.

withEnvironmentVariables

public ProjectEnvironment withEnvironmentVariables(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.

setPrivilegedMode

public void setPrivilegedMode(Boolean privilegedMode)

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

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"

Parameters:

privilegedMode - Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

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"

getPrivilegedMode

public Boolean getPrivilegedMode()

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

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:

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

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"

withPrivilegedMode

public ProjectEnvironment withPrivilegedMode(Boolean privilegedMode)

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

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"

Parameters:

privilegedMode - Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

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:

Returns a reference to this object so that method calls can be chained together.

isPrivilegedMode

public Boolean isPrivilegedMode()

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

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:

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)

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"

setCertificate

public void setCertificate(String certificate)

The certificate to use with this build project.

Parameters:

certificate - The certificate to use with this build project.

getCertificate

public String getCertificate()

The certificate to use with this build project.

Returns:

The certificate to use with this build project.

withCertificate

public ProjectEnvironment withCertificate(String certificate)

The certificate to use with this build project.

Parameters:

certificate - The certificate to use with this build project.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRegistryCredential

public void setRegistryCredential(RegistryCredential registryCredential)

The credentials for access to a private registry.

Parameters:

registryCredential - The credentials for access to a private registry.

getRegistryCredential

public RegistryCredential getRegistryCredential()

The credentials for access to a private registry.

Returns:

The credentials for access to a private registry.

withRegistryCredential

public ProjectEnvironment withRegistryCredential(RegistryCredential 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.

setImagePullCredentialsType

public void setImagePullCredentialsType(String imagePullCredentialsType)

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's 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.

Parameters:

imagePullCredentialsType - 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's 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:

ImagePullCredentialsType

getImagePullCredentialsType

public 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's 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.

Returns:

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's 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:

ImagePullCredentialsType

withImagePullCredentialsType

public ProjectEnvironment withImagePullCredentialsType(String imagePullCredentialsType)

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's 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.

Parameters:

imagePullCredentialsType - 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's 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImagePullCredentialsType

setImagePullCredentialsType

public void setImagePullCredentialsType(ImagePullCredentialsType imagePullCredentialsType)

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's 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.

Parameters:

imagePullCredentialsType - 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's 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:

ImagePullCredentialsType

withImagePullCredentialsType

public ProjectEnvironment withImagePullCredentialsType(ImagePullCredentialsType imagePullCredentialsType)

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's 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.

Parameters:

imagePullCredentialsType - 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's 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImagePullCredentialsType

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ProjectEnvironment clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.