Interface AwsCodeBuildProjectEnvironment.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AwsCodeBuildProjectEnvironment.Builder,
,AwsCodeBuildProjectEnvironment> SdkBuilder<AwsCodeBuildProjectEnvironment.Builder,
,AwsCodeBuildProjectEnvironment> SdkPojo
- Enclosing class:
AwsCodeBuildProjectEnvironment
-
Method Summary
Modifier and TypeMethodDescriptioncertificate
(String certificate) The certificate to use with this build project.environmentVariables
(Collection<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails> environmentVariables) A set of environment variables to make available to builds for the build project.environmentVariables
(Consumer<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails.Builder>... environmentVariables) A set of environment variables to make available to builds for the build project.environmentVariables
(AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails... environmentVariables) A set of environment variables to make available to builds for the build project.imagePullCredentialsType
(String imagePullCredentialsType) The type of credentials CodeBuild uses to pull images in your build.privilegedMode
(Boolean privilegedMode) Whether to allow the Docker daemon to run inside a Docker container.registryCredential
(Consumer<AwsCodeBuildProjectEnvironmentRegistryCredential.Builder> registryCredential) The credentials for access to a private registry.registryCredential
(AwsCodeBuildProjectEnvironmentRegistryCredential registryCredential) The credentials for access to a private registry.The type of build environment to use for related builds.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
environmentVariables
AwsCodeBuildProjectEnvironment.Builder environmentVariables(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.
-
environmentVariables
AwsCodeBuildProjectEnvironment.Builder environmentVariables(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.
-
environmentVariables
AwsCodeBuildProjectEnvironment.Builder environmentVariables(Consumer<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails.Builder>... environmentVariables) A set of environment variables to make available to builds for the build project.
This is a convenience method that creates an instance of theAwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails.Builder
avoiding the need to create one manually viaAwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toenvironmentVariables(List<AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails>)
.- Parameters:
environmentVariables
- a consumer that will call methods onAwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 totrue
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.
-
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 useCODEBUILD
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 useCODEBUILD
credentials.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
registryCredential
AwsCodeBuildProjectEnvironment.Builder registryCredential(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.
-
registryCredential
default AwsCodeBuildProjectEnvironment.Builder registryCredential(Consumer<AwsCodeBuildProjectEnvironmentRegistryCredential.Builder> registryCredential) The credentials for access to a private registry.
This is a convenience method that creates an instance of theAwsCodeBuildProjectEnvironmentRegistryCredential.Builder
avoiding the need to create one manually viaAwsCodeBuildProjectEnvironmentRegistryCredential.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toregistryCredential(AwsCodeBuildProjectEnvironmentRegistryCredential)
.- Parameters:
registryCredential
- a consumer that will call methods onAwsCodeBuildProjectEnvironmentRegistryCredential.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-