Package software.amazon.awssdk.services.codebuild.model

Interface Project.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Project.Builder,Project>, SdkBuilder<Project.Builder,Project>, SdkPojo
Enclosing class:
Project
public static interface Project.Builder extends SdkPojo, CopyableBuilder<Project.Builder,Project>

  • Method Details

    • name

      Project.Builder name(String name)

      The name of the build project.

      Parameters:
      name - The name of the build project.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      Project.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the build project.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the build project.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      Project.Builder description(String description)

      A description that makes the build project easy to identify.

      Parameters:
      description - A description that makes the build project easy to identify.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

      Project.Builder source(ProjectSource source)

      Information about the build input source code for this build project.

      Parameters:
      source - Information about the build input source code for this build project.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • source

      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 the 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 source(ProjectSource).

      Parameters:
      source - a consumer that will call methods on ProjectSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • secondarySources

      Project.Builder secondarySources(Collection<ProjectSource> secondarySources)

      An array of ProjectSource objects.

      Parameters:
      secondarySources - An array of ProjectSource objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondarySources

      Project.Builder secondarySources(ProjectSource... secondarySources)

      An array of ProjectSource objects.

      Parameters:
      secondarySources - An array of ProjectSource objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondarySources

      Project.Builder secondarySources(Consumer<ProjectSource.Builder>... secondarySources)

      An array of ProjectSource objects.

      This is a convenience method that creates an instance of the 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<ProjectSource>).

      Parameters:
      secondarySources - a consumer that will call methods on ProjectSource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceVersion

      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 GitLab: the commit ID, branch, or Git tag to use.

      • 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.

      Parameters:
      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 GitLab: the commit ID, branch, or Git tag to use.

      • 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondarySourceVersions

      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).

      Parameters:
      secondarySourceVersions - An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondarySourceVersions

      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).

      Parameters:
      secondarySourceVersions - An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondarySourceVersions

      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).

      This is a convenience method that creates an instance of the 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<ProjectSourceVersion>).

      Parameters:
      secondarySourceVersions - a consumer that will call methods on ProjectSourceVersion.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • artifacts

      Project.Builder artifacts(ProjectArtifacts artifacts)

      Information about the build output artifacts for the build project.

      Parameters:
      artifacts - Information about the build output artifacts for the build project.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • artifacts

      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 the 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 artifacts(ProjectArtifacts).

      Parameters:
      artifacts - a consumer that will call methods on ProjectArtifacts.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • secondaryArtifacts

      Project.Builder secondaryArtifacts(Collection<ProjectArtifacts> secondaryArtifacts)

      An array of ProjectArtifacts objects.

      Parameters:
      secondaryArtifacts - An array of ProjectArtifacts objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryArtifacts

      Project.Builder secondaryArtifacts(ProjectArtifacts... secondaryArtifacts)

      An array of ProjectArtifacts objects.

      Parameters:
      secondaryArtifacts - An array of ProjectArtifacts objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secondaryArtifacts

      Project.Builder secondaryArtifacts(Consumer<ProjectArtifacts.Builder>... secondaryArtifacts)

      An array of ProjectArtifacts objects.

      This is a convenience method that creates an instance of the 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<ProjectArtifacts>).

      Parameters:
      secondaryArtifacts - a consumer that will call methods on ProjectArtifacts.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • cache

      Project.Builder cache(ProjectCache cache)

      Information about the cache for the build project.

      Parameters:
      cache - Information about the cache for the build project.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cache

      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 the ProjectCache.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).

      Parameters:
      cache - a consumer that will call methods on ProjectCache.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • environment

      Project.Builder environment(ProjectEnvironment environment)

      Information about the build environment for this build project.

      Parameters:
      environment - Information about the build environment for this build project.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environment

      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 the ProjectEnvironment.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).

      Parameters:
      environment - a consumer that will call methods on ProjectEnvironment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serviceRole

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeoutInMinutes

      Project.Builder timeoutInMinutes(Integer timeoutInMinutes)

      How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

      Parameters:
      timeoutInMinutes - How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queuedTimeoutInMinutes

      Project.Builder queuedTimeoutInMinutes(Integer queuedTimeoutInMinutes)

      The number of minutes a build is allowed to be queued before it times out.

      Parameters:
      queuedTimeoutInMinutes - The number of minutes a build is allowed to be queued before it times out.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionKey

      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).

      Parameters:
      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).

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • 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 the Tag.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<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • created

      Project.Builder created(Instant created)

      When the build project was created, expressed in Unix time format.

      Parameters:
      created - When the build project was created, expressed in Unix time format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModified

      Project.Builder lastModified(Instant lastModified)

      When the build project's settings were last modified, expressed in Unix time format.

      Parameters:
      lastModified - When the build project's settings were last modified, expressed in Unix time format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • webhook

      Project.Builder webhook(Webhook webhook)

      Information about a webhook that connects repository events to a build project in CodeBuild.

      Parameters:
      webhook - Information about a webhook that connects repository events to a build project in CodeBuild.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • webhook

      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 the Webhook.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).

      Parameters:
      webhook - a consumer that will call methods on Webhook.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcConfig

      Project.Builder vpcConfig(VpcConfig vpcConfig)

      Information about the VPC configuration that CodeBuild accesses.

      Parameters:
      vpcConfig - Information about the VPC configuration that CodeBuild accesses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      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 the VpcConfig.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).

      Parameters:
      vpcConfig - a consumer that will call methods on VpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • badge

      Project.Builder badge(ProjectBadge badge)

      Information about the build badge for the build project.

      Parameters:
      badge - Information about the build badge for the build project.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • badge

      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 the ProjectBadge.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).

      Parameters:
      badge - a consumer that will call methods on ProjectBadge.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logsConfig

      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.

      Parameters:
      logsConfig - Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logsConfig

      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 the LogsConfig.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).

      Parameters:
      logsConfig - a consumer that will call methods on LogsConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileSystemLocations

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileSystemLocations

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fileSystemLocations

      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.

      This is a convenience method that creates an instance of the 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<ProjectFileSystemLocation>).

      Parameters:
      fileSystemLocations - a consumer that will call methods on ProjectFileSystemLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • buildBatchConfig

      Project.Builder buildBatchConfig(ProjectBuildBatchConfig buildBatchConfig)

      A ProjectBuildBatchConfig object that defines the batch build options for the project.

      Parameters:
      buildBatchConfig - A ProjectBuildBatchConfig object that defines the batch build options for the project.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • buildBatchConfig

      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 the ProjectBuildBatchConfig.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).

      Parameters:
      buildBatchConfig - a consumer that will call methods on ProjectBuildBatchConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • concurrentBuildLimit

      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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • projectVisibility

      Project.Builder projectVisibility(String projectVisibility)
      Sets the value of the ProjectVisibility property for this object.
      Parameters:
      projectVisibility - The new value for the ProjectVisibility property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • projectVisibility

      Project.Builder projectVisibility(ProjectVisibilityType projectVisibility)
      Sets the value of the ProjectVisibility property for this object.
      Parameters:
      projectVisibility - The new value for the ProjectVisibility property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • publicProjectAlias

      Project.Builder publicProjectAlias(String publicProjectAlias)

      Contains the project identifier used with the public build APIs.

      Parameters:
      publicProjectAlias - Contains the project identifier used with the public build APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceAccessRole

      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.

      Parameters:
      resourceAccessRole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.