AwsCodeBuildProjectEnvironment (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsCodeBuildProjectEnvironment

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Information about the build environment for this build project.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsCodeBuildProjectEnvironment()

Constructors
Constructor and Description
`AwsCodeBuildProjectEnvironment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsCodeBuildProjectEnvironment`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCertificate()` The certificate to use with this build project.
`List<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails>`	`getEnvironmentVariables()` A set of environment variables to make available to builds for the build project.
`String`	`getImagePullCredentialsType()` The type of credentials CodeBuild uses to pull images in your build.
`Boolean`	`getPrivilegedMode()` Whether to allow the Docker daemon to run inside a Docker container.
`AwsCodeBuildProjectEnvironmentRegistryCredential`	`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()` Whether to allow the Docker daemon to run 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`	`setEnvironmentVariables(Collection<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails> environmentVariables)` A set of environment variables to make available to builds for the build project.
`void`	`setImagePullCredentialsType(String imagePullCredentialsType)` The type of credentials CodeBuild uses to pull images in your build.
`void`	`setPrivilegedMode(Boolean privilegedMode)` Whether to allow the Docker daemon to run inside a Docker container.
`void`	`setRegistryCredential(AwsCodeBuildProjectEnvironmentRegistryCredential registryCredential)` The credentials for access to a private registry.
`void`	`setType(String type)` The type of build environment to use for related builds.
`String`	`toString()` Returns a string representation of this object.
`AwsCodeBuildProjectEnvironment`	`withCertificate(String certificate)` The certificate to use with this build project.
`AwsCodeBuildProjectEnvironment`	`withEnvironmentVariables(AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails... environmentVariables)` A set of environment variables to make available to builds for the build project.
`AwsCodeBuildProjectEnvironment`	`withEnvironmentVariables(Collection<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails> environmentVariables)` A set of environment variables to make available to builds for the build project.
`AwsCodeBuildProjectEnvironment`	`withImagePullCredentialsType(String imagePullCredentialsType)` The type of credentials CodeBuild uses to pull images in your build.
`AwsCodeBuildProjectEnvironment`	`withPrivilegedMode(Boolean privilegedMode)` Whether to allow the Docker daemon to run inside a Docker container.
`AwsCodeBuildProjectEnvironment`	`withRegistryCredential(AwsCodeBuildProjectEnvironmentRegistryCredential registryCredential)` The credentials for access to a private registry.
`AwsCodeBuildProjectEnvironment`	`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
  - AwsCodeBuildProjectEnvironment
```
public AwsCodeBuildProjectEnvironment()
```
- Method Detail
  - 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 AwsCodeBuildProjectEnvironment 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.
  - getEnvironmentVariables
```
public List<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails> getEnvironmentVariables()
```
    A set of environment variables to make available to builds for the build project.
    
    Returns:
    
    A set of environment variables to make available to builds for the build project.
  - setEnvironmentVariables
```
public void setEnvironmentVariables(Collection<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails> environmentVariables)
```
    A set of environment variables to make available to builds for the build project.
    
    Parameters:
    
    environmentVariables - A set of environment variables to make available to builds for the build project.
  - withEnvironmentVariables
```
public AwsCodeBuildProjectEnvironment withEnvironmentVariables(AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails... environmentVariables)
```
    A set of environment variables to make available to builds for the 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 the build project.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEnvironmentVariables
```
public AwsCodeBuildProjectEnvironment withEnvironmentVariables(Collection<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails> environmentVariables)
```
    A set of environment variables to make available to builds for the build project.
    
    Parameters:
    
    environmentVariables - A set of environment variables to make available to builds for the build project.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrivilegedMode
```
public void setPrivilegedMode(Boolean privilegedMode)
```
    Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.
    
    Parameters:
    
    privilegedMode - Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.
  - getPrivilegedMode
```
public Boolean getPrivilegedMode()
```
    Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.
    
    Returns:
    
    Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.
  - withPrivilegedMode
```
public AwsCodeBuildProjectEnvironment withPrivilegedMode(Boolean privilegedMode)
```
    Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.
    
    Parameters:
    
    privilegedMode - Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPrivilegedMode
```
public Boolean isPrivilegedMode()
```
    Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.
    
    Returns:
    
    Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.
  - setImagePullCredentialsType
```
public void setImagePullCredentialsType(String imagePullCredentialsType)
```
    The type of credentials CodeBuild uses to pull images in your build.
    
    Valid values:
    - CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the 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.
    Parameters:
    imagePullCredentialsType - The type of credentials CodeBuild uses to pull images in your build.
    
    Valid values:
    
    CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the 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.
  - getImagePullCredentialsType
```
public String getImagePullCredentialsType()
```
    The type of credentials CodeBuild uses to pull images in your build.
    
    Valid values:
    - CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the 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.
    Returns:
    The type of credentials CodeBuild uses to pull images in your build.
    
    Valid values:
    
    CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the 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.
  - withImagePullCredentialsType
```
public AwsCodeBuildProjectEnvironment withImagePullCredentialsType(String imagePullCredentialsType)
```
    The type of credentials CodeBuild uses to pull images in your build.
    
    Valid values:
    - CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the 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.
    Parameters:
    imagePullCredentialsType - The type of credentials CodeBuild uses to pull images in your build.
    
    Valid values:
    
    CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegistryCredential
```
public void setRegistryCredential(AwsCodeBuildProjectEnvironmentRegistryCredential registryCredential)
```
    The credentials for access to a private registry.
    
    Parameters:
    
    registryCredential - The credentials for access to a private registry.
  - getRegistryCredential
```
public AwsCodeBuildProjectEnvironmentRegistryCredential getRegistryCredential()
```
    The credentials for access to a private registry.
    
    Returns:
    
    The credentials for access to a private registry.
  - withRegistryCredential
```
public AwsCodeBuildProjectEnvironment withRegistryCredential(AwsCodeBuildProjectEnvironmentRegistryCredential 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.
  - setType
```
public void setType(String type)
```
    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), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).
    
    The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (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 (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
    
    Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER
    
    Parameters:
    
    type - 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), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).
    
    The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (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 (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
    
    Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER
  - getType
```
public String getType()
```
    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), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).
    
    The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (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 (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
    
    Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER
    
    Returns:
    
    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), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).
    
    The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (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 (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
    
    Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER
  - withType
```
public AwsCodeBuildProjectEnvironment withType(String type)
```
    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), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).
    
    The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (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 (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
    
    Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER
    
    Parameters:
    
    type - 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), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt).
    
    The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (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 (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
    
    Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 AwsCodeBuildProjectEnvironment 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.

AWS SDK for Java 1.x API Reference - 1.12.792

Class AwsCodeBuildProjectEnvironment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsCodeBuildProjectEnvironment

Method Detail

setCertificate

getCertificate

withCertificate

getEnvironmentVariables

setEnvironmentVariables

withEnvironmentVariables

withEnvironmentVariables

setPrivilegedMode

getPrivilegedMode

withPrivilegedMode

isPrivilegedMode

setImagePullCredentialsType

getImagePullCredentialsType

withImagePullCredentialsType

setRegistryCredential

getRegistryCredential

withRegistryCredential

setType

getType

withType

toString

equals

hashCode

clone

marshall