public static interface Project.Builder extends SdkPojo, CopyableBuilder<Project.Builder,Project>
| Modifier and Type | Method and Description |
|---|---|
Project.Builder |
arn(String arn)
The Amazon Resource Name (ARN) of the build project.
|
default Project.Builder |
artifacts(Consumer<ProjectArtifacts.Builder> artifacts)
Information about the build output artifacts for the build project.
|
Project.Builder |
artifacts(ProjectArtifacts artifacts)
Information about the build output artifacts for the build project.
|
default Project.Builder |
badge(Consumer<ProjectBadge.Builder> badge)
Information about the build badge for the build project.
|
Project.Builder |
badge(ProjectBadge badge)
Information about the build badge for the build project.
|
default Project.Builder |
buildBatchConfig(Consumer<ProjectBuildBatchConfig.Builder> buildBatchConfig)
A ProjectBuildBatchConfig object that defines the batch build options for the project.
|
Project.Builder |
buildBatchConfig(ProjectBuildBatchConfig buildBatchConfig)
A ProjectBuildBatchConfig object that defines the batch build options for the project.
|
default Project.Builder |
cache(Consumer<ProjectCache.Builder> cache)
Information about the cache for the build project.
|
Project.Builder |
cache(ProjectCache cache)
Information about the cache for the build project.
|
Project.Builder |
concurrentBuildLimit(Integer concurrentBuildLimit)
The maximum number of concurrent builds that are allowed for this project.
|
Project.Builder |
created(Instant created)
When the build project was created, expressed in Unix time format.
|
Project.Builder |
description(String description)
A description that makes the build project easy to identify.
|
Project.Builder |
encryptionKey(String encryptionKey)
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
|
default Project.Builder |
environment(Consumer<ProjectEnvironment.Builder> environment)
Information about the build environment for this build project.
|
Project.Builder |
environment(ProjectEnvironment environment)
Information about the build environment for this build project.
|
Project.Builder |
fileSystemLocations(Collection<ProjectFileSystemLocation> fileSystemLocations)
An array of
ProjectFileSystemLocation objects for a CodeBuild build project. |
Project.Builder |
fileSystemLocations(Consumer<ProjectFileSystemLocation.Builder>... fileSystemLocations)
An array of
ProjectFileSystemLocation objects for a CodeBuild build project. |
Project.Builder |
fileSystemLocations(ProjectFileSystemLocation... fileSystemLocations)
An array of
ProjectFileSystemLocation objects for a CodeBuild build project. |
Project.Builder |
lastModified(Instant lastModified)
When the build project's settings were last modified, expressed in Unix time format.
|
default Project.Builder |
logsConfig(Consumer<LogsConfig.Builder> logsConfig)
Information about logs for the build project.
|
Project.Builder |
logsConfig(LogsConfig logsConfig)
Information about logs for the build project.
|
Project.Builder |
name(String name)
The name of the build project.
|
Project.Builder |
projectVisibility(ProjectVisibilityType projectVisibility)
Sets the value of the ProjectVisibility property for this object.
|
Project.Builder |
projectVisibility(String projectVisibility)
Sets the value of the ProjectVisibility property for this object.
|
Project.Builder |
publicProjectAlias(String publicProjectAlias)
Contains the project identifier used with the public build APIs.
|
Project.Builder |
queuedTimeoutInMinutes(Integer queuedTimeoutInMinutes)
The number of minutes a build is allowed to be queued before it times out.
|
Project.Builder |
resourceAccessRole(String resourceAccessRole)
The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the
project's builds.
|
Project.Builder |
secondaryArtifacts(Collection<ProjectArtifacts> secondaryArtifacts)
An array of
ProjectArtifacts objects. |
Project.Builder |
secondaryArtifacts(Consumer<ProjectArtifacts.Builder>... secondaryArtifacts)
An array of
ProjectArtifacts objects. |
Project.Builder |
secondaryArtifacts(ProjectArtifacts... secondaryArtifacts)
An array of
ProjectArtifacts objects. |
Project.Builder |
secondarySources(Collection<ProjectSource> secondarySources)
An array of
ProjectSource objects. |
Project.Builder |
secondarySources(Consumer<ProjectSource.Builder>... secondarySources)
An array of
ProjectSource objects. |
Project.Builder |
secondarySources(ProjectSource... secondarySources)
An array of
ProjectSource objects. |
Project.Builder |
secondarySourceVersions(Collection<ProjectSourceVersion> secondarySourceVersions)
An array of
ProjectSourceVersion objects. |
Project.Builder |
secondarySourceVersions(Consumer<ProjectSourceVersion.Builder>... secondarySourceVersions)
An array of
ProjectSourceVersion objects. |
Project.Builder |
secondarySourceVersions(ProjectSourceVersion... secondarySourceVersions)
An array of
ProjectSourceVersion objects. |
Project.Builder |
serviceRole(String serviceRole)
The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on
behalf of the Amazon Web Services account.
|
default Project.Builder |
source(Consumer<ProjectSource.Builder> source)
Information about the build input source code for this build project.
|
Project.Builder |
source(ProjectSource source)
Information about the build input source code for this build project.
|
Project.Builder |
sourceVersion(String sourceVersion)
A version of the build input to be built for this project.
|
Project.Builder |
tags(Collection<Tag> tags)
A list of tag key and value pairs associated with this build project.
|
Project.Builder |
tags(Consumer<Tag.Builder>... tags)
A list of tag key and value pairs associated with this build project.
|
Project.Builder |
tags(Tag... tags)
A list of tag key and value pairs associated with this build project.
|
Project.Builder |
timeoutInMinutes(Integer timeoutInMinutes)
How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that
did not get marked as completed.
|
default Project.Builder |
vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)
Information about the VPC configuration that CodeBuild accesses.
|
Project.Builder |
vpcConfig(VpcConfig vpcConfig)
Information about the VPC configuration that CodeBuild accesses.
|
default Project.Builder |
webhook(Consumer<Webhook.Builder> webhook)
Information about a webhook that connects repository events to a build project in CodeBuild.
|
Project.Builder |
webhook(Webhook webhook)
Information about a webhook that connects repository events to a build project in CodeBuild.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildProject.Builder name(String name)
The name of the build project.
name - The name of the build project.Project.Builder arn(String arn)
The Amazon Resource Name (ARN) of the build project.
arn - The Amazon Resource Name (ARN) of the build project.Project.Builder description(String description)
A description that makes the build project easy to identify.
description - A description that makes the build project easy to identify.Project.Builder source(ProjectSource source)
Information about the build input source code for this build project.
source - Information about the build input source code for this build project.default Project.Builder source(Consumer<ProjectSource.Builder> source)
Information about the build input source code for this build project.
This is a convenience method 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)Project.Builder secondarySources(Collection<ProjectSource> secondarySources)
An array of ProjectSource objects.
secondarySources - An array of ProjectSource objects.Project.Builder secondarySources(ProjectSource... secondarySources)
An array of ProjectSource objects.
secondarySources - An array of ProjectSource objects.Project.Builder secondarySources(Consumer<ProjectSource.Builder>... secondarySources)
An array of ProjectSource objects.
ProjectSource.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 #secondarySources(List.
secondarySources - a consumer that will call methods on
ProjectSource.Builder#secondarySources(java.util.Collection) Project.Builder sourceVersion(String sourceVersion)
A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag 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 S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over this
sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
sourceVersion - A version of the build input to be built for this project. If not specified, the latest version is
used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag 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 S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes precedence over
this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
Project.Builder secondarySourceVersions(Collection<ProjectSourceVersion> secondarySourceVersions)
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified
at the build level, then they take over these secondarySourceVersions (at the project level).
secondarySourceVersions - An array of ProjectSourceVersion objects. If secondarySourceVersions is
specified at the build level, then they take over these secondarySourceVersions (at the
project level).Project.Builder secondarySourceVersions(ProjectSourceVersion... secondarySourceVersions)
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified
at the build level, then they take over these secondarySourceVersions (at the project level).
secondarySourceVersions - An array of ProjectSourceVersion objects. If secondarySourceVersions is
specified at the build level, then they take over these secondarySourceVersions (at the
project level).Project.Builder secondarySourceVersions(Consumer<ProjectSourceVersion.Builder>... secondarySourceVersions)
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified
at the build level, then they take over these secondarySourceVersions (at the project level).
ProjectSourceVersion.Builder avoiding the need to
create one manually via
ProjectSourceVersion.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #secondarySourceVersions(List.
secondarySourceVersions - a consumer that will call methods on
ProjectSourceVersion.Builder#secondarySourceVersions(java.util.Collection) Project.Builder artifacts(ProjectArtifacts artifacts)
Information about the build output artifacts for the build project.
artifacts - Information about the build output artifacts for the build project.default Project.Builder artifacts(Consumer<ProjectArtifacts.Builder> artifacts)
Information about the build output artifacts for the build project.
This is a convenience method that creates an instance of theProjectArtifacts.Builder avoiding the
need to create one manually via ProjectArtifacts.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to artifacts(ProjectArtifacts).
artifacts - a consumer that will call methods on ProjectArtifacts.Builderartifacts(ProjectArtifacts)Project.Builder secondaryArtifacts(Collection<ProjectArtifacts> secondaryArtifacts)
An array of ProjectArtifacts objects.
secondaryArtifacts - An array of ProjectArtifacts objects.Project.Builder secondaryArtifacts(ProjectArtifacts... secondaryArtifacts)
An array of ProjectArtifacts objects.
secondaryArtifacts - An array of ProjectArtifacts objects.Project.Builder secondaryArtifacts(Consumer<ProjectArtifacts.Builder>... secondaryArtifacts)
An array of ProjectArtifacts objects.
ProjectArtifacts.Builder avoiding the need to create
one manually via ProjectArtifacts.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #secondaryArtifacts(List.
secondaryArtifacts - a consumer that will call methods on
ProjectArtifacts.Builder#secondaryArtifacts(java.util.Collection) Project.Builder cache(ProjectCache cache)
Information about the cache for the build project.
cache - Information about the cache for the build project.default Project.Builder cache(Consumer<ProjectCache.Builder> cache)
Information about the cache for the build project.
This is a convenience method 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)Project.Builder environment(ProjectEnvironment environment)
Information about the build environment for this build project.
environment - Information about the build environment for this build project.default Project.Builder environment(Consumer<ProjectEnvironment.Builder> environment)
Information about the build environment for this build project.
This is a convenience method 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)Project.Builder serviceRole(String serviceRole)
The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
serviceRole - The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services
on behalf of the Amazon Web Services account.Project.Builder timeoutInMinutes(Integer timeoutInMinutes)
How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
timeoutInMinutes - How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related
build that did not get marked as completed. The default is 60 minutes.Project.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.Project.Builder encryptionKey(String encryptionKey)
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the
format alias/<alias-name>). If you don't specify a value, CodeBuild uses the managed CMK
for Amazon Simple Storage Service (Amazon S3).
encryptionKey - The Key Management Service customer master key (CMK) to be used for encrypting the build output
artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias
(using the format alias/<alias-name>). If you don't specify a value, CodeBuild uses
the managed CMK for Amazon Simple Storage Service (Amazon S3).
Project.Builder tags(Collection<Tag> tags)
A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
tags - A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
Project.Builder tags(Tag... tags)
A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
tags - A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
Project.Builder tags(Consumer<Tag.Builder>... tags)
A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
This is a convenience method that creates an instance of theTag.Builder avoiding the need to create one manually
via Tag.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #tags(List.
tags - a consumer that will call methods on
Tag.Builder#tags(java.util.Collection) Project.Builder created(Instant created)
When the build project was created, expressed in Unix time format.
created - When the build project was created, expressed in Unix time format.Project.Builder lastModified(Instant lastModified)
When the build project's settings were last modified, expressed in Unix time format.
lastModified - When the build project's settings were last modified, expressed in Unix time format.Project.Builder webhook(Webhook webhook)
Information about a webhook that connects repository events to a build project in CodeBuild.
webhook - Information about a webhook that connects repository events to a build project in CodeBuild.default Project.Builder webhook(Consumer<Webhook.Builder> webhook)
Information about a webhook that connects repository events to a build project in CodeBuild.
This is a convenience method that creates an instance of theWebhook.Builder avoiding the need to
create one manually via Webhook.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result is
passed to webhook(Webhook).
webhook - a consumer that will call methods on Webhook.Builderwebhook(Webhook)Project.Builder vpcConfig(VpcConfig vpcConfig)
Information about the VPC configuration that CodeBuild accesses.
vpcConfig - Information about the VPC configuration that CodeBuild accesses.default Project.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)
Information about the VPC configuration that CodeBuild accesses.
This is a convenience method 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)Project.Builder badge(ProjectBadge badge)
Information about the build badge for the build project.
badge - Information about the build badge for the build project.default Project.Builder badge(Consumer<ProjectBadge.Builder> badge)
Information about the build badge for the build project.
This is a convenience method that creates an instance of theProjectBadge.Builder avoiding the need
to create one manually via ProjectBadge.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to badge(ProjectBadge).
badge - a consumer that will call methods on ProjectBadge.Builderbadge(ProjectBadge)Project.Builder logsConfig(LogsConfig logsConfig)
Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
logsConfig - Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3
bucket, or both.default Project.Builder logsConfig(Consumer<LogsConfig.Builder> logsConfig)
Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
This is a convenience method that creates an instance of theLogsConfig.Builder avoiding the need to
create one manually via LogsConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to logsConfig(LogsConfig).
logsConfig - a consumer that will call methods on LogsConfig.BuilderlogsConfig(LogsConfig)Project.Builder fileSystemLocations(Collection<ProjectFileSystemLocation> fileSystemLocations)
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A
ProjectFileSystemLocation object specifies the identifier, location,
mountOptions, mountPoint, and type of a file system created using
Amazon Elastic File System.
fileSystemLocations - An array of ProjectFileSystemLocation objects for a CodeBuild build project. A
ProjectFileSystemLocation object specifies the identifier,
location, mountOptions, mountPoint, and type of a
file system created using Amazon Elastic File System.Project.Builder fileSystemLocations(ProjectFileSystemLocation... fileSystemLocations)
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A
ProjectFileSystemLocation object specifies the identifier, location,
mountOptions, mountPoint, and type of a file system created using
Amazon Elastic File System.
fileSystemLocations - An array of ProjectFileSystemLocation objects for a CodeBuild build project. A
ProjectFileSystemLocation object specifies the identifier,
location, mountOptions, mountPoint, and type of a
file system created using Amazon Elastic File System.Project.Builder fileSystemLocations(Consumer<ProjectFileSystemLocation.Builder>... fileSystemLocations)
An array of ProjectFileSystemLocation objects for a CodeBuild build project. A
ProjectFileSystemLocation object specifies the identifier, location,
mountOptions, mountPoint, and type of a file system created using
Amazon Elastic File System.
ProjectFileSystemLocation.Builder avoiding the need
to create one manually via
ProjectFileSystemLocation.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #fileSystemLocations(List.
fileSystemLocations - a consumer that will call methods on
ProjectFileSystemLocation.Builder#fileSystemLocations(java.util.Collection) Project.Builder buildBatchConfig(ProjectBuildBatchConfig buildBatchConfig)
A ProjectBuildBatchConfig object that defines the batch build options for the project.
buildBatchConfig - A ProjectBuildBatchConfig object that defines the batch build options for the project.default Project.Builder buildBatchConfig(Consumer<ProjectBuildBatchConfig.Builder> buildBatchConfig)
A ProjectBuildBatchConfig object that defines the batch build options for the project.
This is a convenience method that creates an instance of theProjectBuildBatchConfig.Builder avoiding
the need to create one manually via ProjectBuildBatchConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to buildBatchConfig(ProjectBuildBatchConfig).
buildBatchConfig - a consumer that will call methods on ProjectBuildBatchConfig.BuilderbuildBatchConfig(ProjectBuildBatchConfig)Project.Builder concurrentBuildLimit(Integer concurrentBuildLimit)
The maximum number of concurrent builds that are allowed for this project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
concurrentBuildLimit - The maximum number of concurrent builds that are allowed for this project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
Project.Builder projectVisibility(String projectVisibility)
projectVisibility - The new value for the ProjectVisibility property for this object.ProjectVisibilityType,
ProjectVisibilityTypeProject.Builder projectVisibility(ProjectVisibilityType projectVisibility)
projectVisibility - The new value for the ProjectVisibility property for this object.ProjectVisibilityType,
ProjectVisibilityTypeProject.Builder publicProjectAlias(String publicProjectAlias)
Contains the project identifier used with the public build APIs.
publicProjectAlias - Contains the project identifier used with the public build APIs.Project.Builder resourceAccessRole(String resourceAccessRole)
The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
resourceAccessRole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts
for the project's builds.Copyright © 2023. All rights reserved.