@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.
Constructor and Description |
---|
AwsCodeBuildProjectEnvironment() |
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.
|
public void setCertificate(String certificate)
The certificate to use with this build project.
certificate
- The certificate to use with this build project.public String getCertificate()
The certificate to use with this build project.
public AwsCodeBuildProjectEnvironment withCertificate(String certificate)
The certificate to use with this build project.
certificate
- The certificate to use with this build project.public List<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails> getEnvironmentVariables()
A set of environment variables to make available to builds for the build project.
public void setEnvironmentVariables(Collection<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails> environmentVariables)
A set of environment variables to make available to builds for the build project.
environmentVariables
- A set of environment variables to make available to builds for the build project.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.
environmentVariables
- A set of environment variables to make available to builds for the build project.public AwsCodeBuildProjectEnvironment withEnvironmentVariables(Collection<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails> environmentVariables)
A set of environment variables to make available to builds for the build project.
environmentVariables
- A set of environment variables to make available to builds for the build project.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.
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.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.
true
if the
build project is used to build Docker images.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.
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.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.
true
if the
build project is used to build Docker images.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.
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.
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.
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.
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.
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.
public void setRegistryCredential(AwsCodeBuildProjectEnvironmentRegistryCredential registryCredential)
The credentials for access to a private registry.
registryCredential
- The credentials for access to a private registry.public AwsCodeBuildProjectEnvironmentRegistryCredential getRegistryCredential()
The credentials for access to a private registry.
public AwsCodeBuildProjectEnvironment withRegistryCredential(AwsCodeBuildProjectEnvironmentRegistryCredential registryCredential)
The credentials for access to a private registry.
registryCredential
- The credentials for access to a private registry.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
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
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
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
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
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
public String toString()
toString
in class Object
Object.toString()
public AwsCodeBuildProjectEnvironment clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.