software.amazon.awssdk.services.codebuild.model

Interface ProjectSource.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ProjectSource.Builder,ProjectSource>, SdkBuilder<ProjectSource.Builder,ProjectSource>, SdkPojo

Enclosing class:

ProjectSource

public static interface ProjectSource.Builder
extends SdkPojo, CopyableBuilder<ProjectSource.Builder,ProjectSource>

Method Summary

Modifier and Type	Method and Description
default ProjectSource.Builder	auth(Consumer<SourceAuth.Builder> auth) Information about the authorization settings for CodeBuild to access the source code to be built.
ProjectSource.Builder	auth(SourceAuth auth) Information about the authorization settings for CodeBuild to access the source code to be built.
ProjectSource.Builder	buildspec(String buildspec) The buildspec file declaration to use for the builds in this build project.
ProjectSource.Builder	buildStatusConfig(BuildStatusConfig buildStatusConfig) Contains information that defines how the build project reports the build status to the source provider.
default ProjectSource.Builder	buildStatusConfig(Consumer<BuildStatusConfig.Builder> buildStatusConfig) Contains information that defines how the build project reports the build status to the source provider.
ProjectSource.Builder	gitCloneDepth(Integer gitCloneDepth) Information about the Git clone depth for the build project.
default ProjectSource.Builder	gitSubmodulesConfig(Consumer<GitSubmodulesConfig.Builder> gitSubmodulesConfig) Information about the Git submodules configuration for the build project.
ProjectSource.Builder	gitSubmodulesConfig(GitSubmodulesConfig gitSubmodulesConfig) Information about the Git submodules configuration for the build project.
ProjectSource.Builder	insecureSsl(Boolean insecureSsl) Enable this flag to ignore SSL warnings while connecting to the project source code.
ProjectSource.Builder	location(String location) Information about the location of the source code to be built.
ProjectSource.Builder	reportBuildStatus(Boolean reportBuildStatus) Set to true to report the status of a build's start and finish to your source provider.
ProjectSource.Builder	sourceIdentifier(String sourceIdentifier) An identifier for this project source.
ProjectSource.Builder	type(SourceType type) The type of repository that contains the source code to be built.
ProjectSource.Builder	type(String type) The type of repository that contains the source code to be built.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

type

ProjectSource.Builder type(String type)

The type of repository that contains the source code to be built. Valid values include:

• BITBUCKET: The source code is in a Bitbucket repository.

• CODECOMMIT: The source code is in an CodeCommit repository.

• CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.

• GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud repository.

• GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.

• NO_SOURCE: The project does not have input source code.

• S3: The source code is in an Amazon S3 bucket.

Parameters:

type - The type of repository that contains the source code to be built. Valid values include:

• BITBUCKET: The source code is in a Bitbucket repository.

• CODECOMMIT: The source code is in an CodeCommit repository.

• CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.

• GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud repository.

• GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.

• NO_SOURCE: The project does not have input source code.

• S3: The source code is in an Amazon S3 bucket.

Returns:

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

See Also:

SourceType, SourceType

type

ProjectSource.Builder type(SourceType type)

The type of repository that contains the source code to be built. Valid values include:

• BITBUCKET: The source code is in a Bitbucket repository.

• CODECOMMIT: The source code is in an CodeCommit repository.

• CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.

• GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud repository.

• GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.

• NO_SOURCE: The project does not have input source code.

• S3: The source code is in an Amazon S3 bucket.

Parameters:

type - The type of repository that contains the source code to be built. Valid values include:

• BITBUCKET: The source code is in a Bitbucket repository.

• CODECOMMIT: The source code is in an CodeCommit repository.

• CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.

• GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud repository.

• GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.

• NO_SOURCE: The project does not have input source code.

• S3: The source code is in an Amazon S3 bucket.

Returns:

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

See Also:

SourceType, SourceType

location

ProjectSource.Builder location(String location)

Information about the location of the source code to be built. Valid values include:

• For source code settings that are specified in the source action of a pipeline in CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.

• For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).

• For source code in an Amazon S3 input bucket, one of the following.

  • The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<object-name>.zip).

  • The path to the folder that contains the source code (for example, <bucket-name>/<path-to-source-code>/<folder>/).

• For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.

• For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.

If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify Location.

Parameters:

location - Information about the location of the source code to be built. Valid values include:

• For source code settings that are specified in the source action of a pipeline in CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.

• For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).

• For source code in an Amazon S3 input bucket, one of the following.

  • The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<object-name>.zip).

  • The path to the folder that contains the source code (for example, <bucket-name>/<path-to-source-code>/<folder>/).

• For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.

• For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.

If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify Location.

Returns:

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

gitCloneDepth

ProjectSource.Builder gitCloneDepth(Integer gitCloneDepth)

Information about the Git clone depth for the build project.

Parameters:

gitCloneDepth - Information about the Git clone depth for the build project.

Returns:

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

gitSubmodulesConfig

ProjectSource.Builder gitSubmodulesConfig(GitSubmodulesConfig gitSubmodulesConfig)

Information about the Git submodules configuration for the build project.

Parameters:

gitSubmodulesConfig - Information about the Git submodules configuration for the build project.

Returns:

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

gitSubmodulesConfig

default ProjectSource.Builder gitSubmodulesConfig(Consumer<GitSubmodulesConfig.Builder> gitSubmodulesConfig)

Information about the Git submodules configuration for the build project.

This is a convenience method that creates an instance of the GitSubmodulesConfig.Builder avoiding the need to create one manually via GitSubmodulesConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to gitSubmodulesConfig(GitSubmodulesConfig).

Parameters:

gitSubmodulesConfig - a consumer that will call methods on GitSubmodulesConfig.Builder

Returns:

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

See Also:

gitSubmodulesConfig(GitSubmodulesConfig)

buildspec

ProjectSource.Builder buildspec(String buildspec)

The buildspec file declaration to use for the builds in this build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Parameters:

buildspec - The buildspec file declaration to use for the builds in this build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Returns:

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

auth

ProjectSource.Builder auth(SourceAuth auth)

Information about the authorization settings for CodeBuild to access the source code to be built.

This information is for the CodeBuild console's use only. Your code should not get or set this information directly.

Parameters:

auth - Information about the authorization settings for CodeBuild to access the source code to be built.

This information is for the CodeBuild console's use only. Your code should not get or set this information directly.

Returns:

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

auth

default ProjectSource.Builder auth(Consumer<SourceAuth.Builder> auth)

Information about the authorization settings for CodeBuild to access the source code to be built.

This information is for the CodeBuild console's use only. Your code should not get or set this information directly.

This is a convenience method that creates an instance of the SourceAuth.Builder avoiding the need to create one manually via SourceAuth.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to auth(SourceAuth).

Parameters:

auth - a consumer that will call methods on SourceAuth.Builder

Returns:

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

See Also:

auth(SourceAuth)

reportBuildStatus

ProjectSource.Builder reportBuildStatus(Boolean reportBuildStatus)

Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.

To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.

The status of a build triggered by a webhook is always reported to your source provider.

If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.

Parameters:

reportBuildStatus - Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.

To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.

The status of a build triggered by a webhook is always reported to your source provider.

If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.

Returns:

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

buildStatusConfig

ProjectSource.Builder buildStatusConfig(BuildStatusConfig buildStatusConfig)

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

Parameters:

buildStatusConfig - Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

Returns:

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

buildStatusConfig

default ProjectSource.Builder buildStatusConfig(Consumer<BuildStatusConfig.Builder> buildStatusConfig)

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

This is a convenience method that creates an instance of the BuildStatusConfig.Builder avoiding the need to create one manually via BuildStatusConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to buildStatusConfig(BuildStatusConfig).

Parameters:

buildStatusConfig - a consumer that will call methods on BuildStatusConfig.Builder

Returns:

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

See Also:

buildStatusConfig(BuildStatusConfig)

insecureSsl

ProjectSource.Builder insecureSsl(Boolean insecureSsl)

Enable this flag to ignore SSL warnings while connecting to the project source code.

Parameters:

insecureSsl - Enable this flag to ignore SSL warnings while connecting to the project source code.

Returns:

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

sourceIdentifier

ProjectSource.Builder sourceIdentifier(String sourceIdentifier)

An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.

Parameters:

sourceIdentifier - An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.

Returns:

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