public static interface Build.Builder extends SdkPojo, CopyableBuilder<Build.Builder,Build>
| Modifier and Type | Method and Description |
|---|---|
Build.Builder |
arn(String arn)
The Amazon Resource Name (ARN) of the build.
|
Build.Builder |
artifacts(BuildArtifacts artifacts)
Information about the output artifacts for the build.
|
default Build.Builder |
artifacts(Consumer<BuildArtifacts.Builder> artifacts)
Information about the output artifacts for the build.
|
Build.Builder |
buildComplete(Boolean buildComplete)
Whether the build is complete.
|
Build.Builder |
buildStatus(StatusType buildStatus)
The current status of the build.
|
Build.Builder |
buildStatus(String buildStatus)
The current status of the build.
|
default Build.Builder |
cache(Consumer<ProjectCache.Builder> cache)
Information about the cache for the build.
|
Build.Builder |
cache(ProjectCache cache)
Information about the cache for the build.
|
Build.Builder |
currentPhase(String currentPhase)
The current build phase.
|
Build.Builder |
encryptionKey(String encryptionKey)
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output
artifacts.
|
Build.Builder |
endTime(Instant endTime)
When the build process ended, expressed in Unix time format.
|
default Build.Builder |
environment(Consumer<ProjectEnvironment.Builder> environment)
Information about the build environment for this build.
|
Build.Builder |
environment(ProjectEnvironment environment)
Information about the build environment for this build.
|
Build.Builder |
id(String id)
The unique ID for the build.
|
Build.Builder |
initiator(String initiator)
The entity that started the build.
|
default Build.Builder |
logs(Consumer<LogsLocation.Builder> logs)
Information about the build's logs in Amazon CloudWatch Logs.
|
Build.Builder |
logs(LogsLocation logs)
Information about the build's logs in Amazon CloudWatch Logs.
|
default Build.Builder |
networkInterface(Consumer<NetworkInterface.Builder> networkInterface)
Describes a network interface.
|
Build.Builder |
networkInterface(NetworkInterface networkInterface)
Describes a network interface.
|
Build.Builder |
phases(BuildPhase... phases)
Information about all previous build phases that are complete and information about any current build phase
that is not yet complete.
|
Build.Builder |
phases(Collection<BuildPhase> phases)
Information about all previous build phases that are complete and information about any current build phase
that is not yet complete.
|
Build.Builder |
phases(Consumer<BuildPhase.Builder>... phases)
Information about all previous build phases that are complete and information about any current build phase
that is not yet complete.
|
Build.Builder |
projectName(String projectName)
The name of the AWS CodeBuild project.
|
Build.Builder |
queuedTimeoutInMinutes(Integer queuedTimeoutInMinutes)
The number of minutes a build is allowed to be queued before it times out.
|
Build.Builder |
resolvedSourceVersion(String resolvedSourceVersion)
An identifier for the version of this build's source code.
|
Build.Builder |
secondaryArtifacts(BuildArtifacts... secondaryArtifacts)
An array of
ProjectArtifacts objects. |
Build.Builder |
secondaryArtifacts(Collection<BuildArtifacts> secondaryArtifacts)
An array of
ProjectArtifacts objects. |
Build.Builder |
secondaryArtifacts(Consumer<BuildArtifacts.Builder>... secondaryArtifacts)
An array of
ProjectArtifacts objects. |
Build.Builder |
secondarySources(Collection<ProjectSource> secondarySources)
An array of
ProjectSource objects. |
Build.Builder |
secondarySources(Consumer<ProjectSource.Builder>... secondarySources)
An array of
ProjectSource objects. |
Build.Builder |
secondarySources(ProjectSource... secondarySources)
An array of
ProjectSource objects. |
Build.Builder |
secondarySourceVersions(Collection<ProjectSourceVersion> secondarySourceVersions)
An array of
ProjectSourceVersion objects. |
Build.Builder |
secondarySourceVersions(Consumer<ProjectSourceVersion.Builder>... secondarySourceVersions)
An array of
ProjectSourceVersion objects. |
Build.Builder |
secondarySourceVersions(ProjectSourceVersion... secondarySourceVersions)
An array of
ProjectSourceVersion objects. |
Build.Builder |
serviceRole(String serviceRole)
The name of a service role used for this build.
|
default Build.Builder |
source(Consumer<ProjectSource.Builder> source)
Information about the source code to be built.
|
Build.Builder |
source(ProjectSource source)
Information about the source code to be built.
|
Build.Builder |
sourceVersion(String sourceVersion)
Any version identifier for the version of the source code to be built.
|
Build.Builder |
startTime(Instant startTime)
When the build process started, expressed in Unix time format.
|
Build.Builder |
timeoutInMinutes(Integer timeoutInMinutes)
How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as
completed.
|
default Build.Builder |
vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)
If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies
the VPC ID and the list of security group IDs and subnet IDs.
|
Build.Builder |
vpcConfig(VpcConfig vpcConfig)
If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies
the VPC ID and the list of security group IDs and subnet IDs.
|
copyapplyMutation, buildBuild.Builder id(String id)
The unique ID for the build.
id - The unique ID for the build.Build.Builder arn(String arn)
The Amazon Resource Name (ARN) of the build.
arn - The Amazon Resource Name (ARN) of the build.Build.Builder startTime(Instant startTime)
When the build process started, expressed in Unix time format.
startTime - When the build process started, expressed in Unix time format.Build.Builder endTime(Instant endTime)
When the build process ended, expressed in Unix time format.
endTime - When the build process ended, expressed in Unix time format.Build.Builder currentPhase(String currentPhase)
The current build phase.
currentPhase - The current build phase.Build.Builder buildStatus(String buildStatus)
The current status of the build. Valid values include:
FAILED: The build failed.
FAULT: The build faulted.
IN_PROGRESS: The build is still in progress.
STOPPED: The build stopped.
SUCCEEDED: The build succeeded.
TIMED_OUT: The build timed out.
buildStatus - The current status of the build. Valid values include:
FAILED: The build failed.
FAULT: The build faulted.
IN_PROGRESS: The build is still in progress.
STOPPED: The build stopped.
SUCCEEDED: The build succeeded.
TIMED_OUT: The build timed out.
StatusType,
StatusTypeBuild.Builder buildStatus(StatusType buildStatus)
The current status of the build. Valid values include:
FAILED: The build failed.
FAULT: The build faulted.
IN_PROGRESS: The build is still in progress.
STOPPED: The build stopped.
SUCCEEDED: The build succeeded.
TIMED_OUT: The build timed out.
buildStatus - The current status of the build. Valid values include:
FAILED: The build failed.
FAULT: The build faulted.
IN_PROGRESS: The build is still in progress.
STOPPED: The build stopped.
SUCCEEDED: The build succeeded.
TIMED_OUT: The build timed out.
StatusType,
StatusTypeBuild.Builder sourceVersion(String sourceVersion)
Any version identifier for the version of the source code to be built.
sourceVersion - Any version identifier for the version of the source code to be built.Build.Builder resolvedSourceVersion(String resolvedSourceVersion)
An identifier for the version of this build's source code.
For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For AWS CodePipeline, the source revision provided by AWS CodePipeline.
For Amazon Simple Storage Service (Amazon S3), this does not apply.
resolvedSourceVersion - An identifier for the version of this build's source code.
For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For AWS CodePipeline, the source revision provided by AWS CodePipeline.
For Amazon Simple Storage Service (Amazon S3), this does not apply.
Build.Builder projectName(String projectName)
The name of the AWS CodeBuild project.
projectName - The name of the AWS CodeBuild project.Build.Builder phases(Collection<BuildPhase> phases)
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
phases - Information about all previous build phases that are complete and information about any current build
phase that is not yet complete.Build.Builder phases(BuildPhase... phases)
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
phases - Information about all previous build phases that are complete and information about any current build
phase that is not yet complete.Build.Builder phases(Consumer<BuildPhase.Builder>... phases)
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
This is a convenience that creates an instance of theList.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its
result is passed to #phases(List) .phases - a consumer that will call methods on List.Builder #phases(List) Build.Builder source(ProjectSource source)
Information about the source code to be built.
source - Information about the source code to be built.default Build.Builder source(Consumer<ProjectSource.Builder> source)
Information about the source code to be built.
This is a convenience that creates an instance of theProjectSource.Builder avoiding the need to
create one manually via ProjectSource.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to source(ProjectSource).source - a consumer that will call methods on ProjectSource.Buildersource(ProjectSource)Build.Builder secondarySources(Collection<ProjectSource> secondarySources)
An array of ProjectSource objects.
secondarySources - An array of ProjectSource objects.Build.Builder secondarySources(ProjectSource... secondarySources)
An array of ProjectSource objects.
secondarySources - An array of ProjectSource objects.Build.Builder secondarySources(Consumer<ProjectSource.Builder>... secondarySources)
An array of ProjectSource objects.
List.Builder avoiding the need
to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #secondarySources(List) .secondarySources - a consumer that will call methods on List.Builder #secondarySources(List) Build.Builder secondarySourceVersions(Collection<ProjectSourceVersion> secondarySourceVersions)
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For AWS CodeCommit: the commit ID to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the
source code you want to build. If a pull request ID is specified, it must use the format
pr/pull-request-ID (for example, pr/25). If a branch name is specified, the
branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
secondarySourceVersions - An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be
one of:
For AWS CodeCommit: the commit ID to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version
of the source code you want to build. If a pull request ID is specified, it must use the format
pr/pull-request-ID (for example, pr/25). If a branch name is specified, the
branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
Build.Builder secondarySourceVersions(ProjectSourceVersion... secondarySourceVersions)
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For AWS CodeCommit: the commit ID to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the
source code you want to build. If a pull request ID is specified, it must use the format
pr/pull-request-ID (for example, pr/25). If a branch name is specified, the
branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
secondarySourceVersions - An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be
one of:
For AWS CodeCommit: the commit ID to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version
of the source code you want to build. If a pull request ID is specified, it must use the format
pr/pull-request-ID (for example, pr/25). If a branch name is specified, the
branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
Build.Builder secondarySourceVersions(Consumer<ProjectSourceVersion.Builder>... secondarySourceVersions)
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For AWS CodeCommit: the commit ID to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the
source code you want to build. If a pull request ID is specified, it must use the format
pr/pull-request-ID (for example, pr/25). If a branch name is specified, the
branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.
List.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately
and its result is passed to #secondarySourceVersions(List) .secondarySourceVersions - a consumer that will call methods on List.Builder #secondarySourceVersions(List) Build.Builder artifacts(BuildArtifacts artifacts)
Information about the output artifacts for the build.
artifacts - Information about the output artifacts for the build.default Build.Builder artifacts(Consumer<BuildArtifacts.Builder> artifacts)
Information about the output artifacts for the build.
This is a convenience that creates an instance of theBuildArtifacts.Builder avoiding the need to
create one manually via BuildArtifacts.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to artifacts(BuildArtifacts).artifacts - a consumer that will call methods on BuildArtifacts.Builderartifacts(BuildArtifacts)Build.Builder secondaryArtifacts(Collection<BuildArtifacts> secondaryArtifacts)
An array of ProjectArtifacts objects.
secondaryArtifacts - An array of ProjectArtifacts objects.Build.Builder secondaryArtifacts(BuildArtifacts... secondaryArtifacts)
An array of ProjectArtifacts objects.
secondaryArtifacts - An array of ProjectArtifacts objects.Build.Builder secondaryArtifacts(Consumer<BuildArtifacts.Builder>... secondaryArtifacts)
An array of ProjectArtifacts objects.
List.Builder avoiding the need
to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #secondaryArtifacts(List) .secondaryArtifacts - a consumer that will call methods on List.Builder #secondaryArtifacts(List) Build.Builder cache(ProjectCache cache)
Information about the cache for the build.
cache - Information about the cache for the build.default Build.Builder cache(Consumer<ProjectCache.Builder> cache)
Information about the cache for the build.
This is a convenience that creates an instance of theProjectCache.Builder avoiding the need to
create one manually via ProjectCache.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to cache(ProjectCache).cache - a consumer that will call methods on ProjectCache.Buildercache(ProjectCache)Build.Builder environment(ProjectEnvironment environment)
Information about the build environment for this build.
environment - Information about the build environment for this build.default Build.Builder environment(Consumer<ProjectEnvironment.Builder> environment)
Information about the build environment for this build.
This is a convenience that creates an instance of theProjectEnvironment.Builder avoiding the need to
create one manually via ProjectEnvironment.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to environment(ProjectEnvironment).environment - a consumer that will call methods on ProjectEnvironment.Builderenvironment(ProjectEnvironment)Build.Builder serviceRole(String serviceRole)
The name of a service role used for this build.
serviceRole - The name of a service role used for this build.Build.Builder logs(LogsLocation logs)
Information about the build's logs in Amazon CloudWatch Logs.
logs - Information about the build's logs in Amazon CloudWatch Logs.default Build.Builder logs(Consumer<LogsLocation.Builder> logs)
Information about the build's logs in Amazon CloudWatch Logs.
This is a convenience that creates an instance of theLogsLocation.Builder avoiding the need to
create one manually via LogsLocation.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to logs(LogsLocation).logs - a consumer that will call methods on LogsLocation.Builderlogs(LogsLocation)Build.Builder timeoutInMinutes(Integer timeoutInMinutes)
How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.
timeoutInMinutes - How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked
as completed.Build.Builder queuedTimeoutInMinutes(Integer queuedTimeoutInMinutes)
The number of minutes a build is allowed to be queued before it times out.
queuedTimeoutInMinutes - The number of minutes a build is allowed to be queued before it times out.Build.Builder buildComplete(Boolean buildComplete)
Whether the build is complete. True if complete; otherwise, false.
buildComplete - Whether the build is complete. True if complete; otherwise, false.Build.Builder initiator(String initiator)
The entity that started the build. Valid values include:
If AWS CodePipeline started the build, the pipeline's name (for example,
codepipeline/my-demo-pipeline).
If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example,
MyUserName).
If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
initiator - The entity that started the build. Valid values include:
If AWS CodePipeline started the build, the pipeline's name (for example,
codepipeline/my-demo-pipeline).
If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example,
MyUserName).
If the Jenkins plugin for AWS CodeBuild started the build, the string
CodeBuild-Jenkins-Plugin.
Build.Builder vpcConfig(VpcConfig vpcConfig)
If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
vpcConfig - If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that
identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and
subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.default Build.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)
If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
This is a convenience that creates an instance of theVpcConfig.Builder avoiding the need to create
one manually via VpcConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to vpcConfig(VpcConfig).vpcConfig - a consumer that will call methods on VpcConfig.BuildervpcConfig(VpcConfig)Build.Builder networkInterface(NetworkInterface networkInterface)
Describes a network interface.
networkInterface - Describes a network interface.default Build.Builder networkInterface(Consumer<NetworkInterface.Builder> networkInterface)
Describes a network interface.
This is a convenience that creates an instance of theNetworkInterface.Builder avoiding the need to
create one manually via NetworkInterface.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to networkInterface(NetworkInterface).networkInterface - a consumer that will call methods on NetworkInterface.BuildernetworkInterface(NetworkInterface)Build.Builder encryptionKey(String encryptionKey)
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
This is expressed either as the Amazon Resource Name (ARN) of the CMK or, if specified, the CMK's alias
(using the format alias/alias-name ).
encryptionKey - The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build
output artifacts.
This is expressed either as the Amazon Resource Name (ARN) of the CMK or, if specified, the CMK's
alias (using the format alias/alias-name ).
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.