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

Interface CreateProjectRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CodeBuildRequest.Builder, CopyableBuilder<CreateProjectRequest.Builder,CreateProjectRequest>, SdkBuilder<CreateProjectRequest.Builder,CreateProjectRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateProjectRequest
public static interface CreateProjectRequest.Builder extends CodeBuildRequest.Builder, SdkPojo, CopyableBuilder<CreateProjectRequest.Builder,CreateProjectRequest>

  • Method Details

    • name

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

    • description

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

      CreateProjectRequest.Builder source(ProjectSource source)

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

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

    • source

      default CreateProjectRequest.Builder source(Consumer<ProjectSource.Builder> source)

      Information about the build input source code for the 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

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

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

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

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

      CreateProjectRequest.Builder secondarySourceVersions(Collection<ProjectSourceVersion> secondarySourceVersions)

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

    • secondarySourceVersions

      CreateProjectRequest.Builder secondarySourceVersions(ProjectSourceVersion... secondarySourceVersions)

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

    • secondarySourceVersions

      CreateProjectRequest.Builder secondarySourceVersions(Consumer<ProjectSourceVersion.Builder>... secondarySourceVersions)

      An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence 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

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

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

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

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

      CreateProjectRequest.Builder cache(ProjectCache cache)

      Stores recently used information so that it can be quickly accessed at a later time.

      Parameters:
      cache - Stores recently used information so that it can be quickly accessed at a later time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cache

      default CreateProjectRequest.Builder cache(Consumer<ProjectCache.Builder> cache)

      Stores recently used information so that it can be quickly accessed at a later time.

      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

      CreateProjectRequest.Builder environment(ProjectEnvironment environment)

      Information about the build environment for the build project.

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

    • environment

      default CreateProjectRequest.Builder environment(Consumer<ProjectEnvironment.Builder> environment)

      Information about the build environment for the 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

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

      CreateProjectRequest.Builder timeoutInMinutes(Integer timeoutInMinutes)

      How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before it times out any build that has not been 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 it times out any build that has not been marked as completed. The default is 60 minutes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queuedTimeoutInMinutes

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

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

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

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

    • tags

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

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

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

    • vpcConfig

      CreateProjectRequest.Builder vpcConfig(VpcConfig vpcConfig)

      VpcConfig enables CodeBuild to access resources in an Amazon VPC.

      If you're using compute fleets during project creation, do not provide vpcConfig.

      Parameters:
      vpcConfig - VpcConfig enables CodeBuild to access resources in an Amazon VPC.

      If you're using compute fleets during project creation, do not provide vpcConfig.

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

    • vpcConfig

      default CreateProjectRequest.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

      VpcConfig enables CodeBuild to access resources in an Amazon VPC.

      If you're using compute fleets during project creation, do not provide vpcConfig.

      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:

    • badgeEnabled

      CreateProjectRequest.Builder badgeEnabled(Boolean badgeEnabled)

      Set this to true to generate a publicly accessible URL for your project's build badge.

      Parameters:
      badgeEnabled - Set this to true to generate a publicly accessible URL for your project's build badge.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logsConfig

      CreateProjectRequest.Builder logsConfig(LogsConfig logsConfig)

      Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.

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

    • logsConfig

      default CreateProjectRequest.Builder logsConfig(Consumer<LogsConfig.Builder> logsConfig)

      Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified 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

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

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

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

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

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

    • overrideConfiguration

      CreateProjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateProjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.