public static interface ProjectSource.Builder extends SdkPojo, CopyableBuilder<ProjectSource.Builder,ProjectSource>
Modifier and Type | Method and Description |
---|---|
default ProjectSource.Builder |
auth(Consumer<SourceAuth.Builder> auth)
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
|
ProjectSource.Builder |
auth(SourceAuth auth)
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
|
ProjectSource.Builder |
buildspec(String buildspec)
The build spec declaration to use for the builds in this build project.
|
ProjectSource.Builder |
gitCloneDepth(Integer gitCloneDepth)
Information about the git clone depth 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.
|
copy
applyMutation, build
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 AWS CodeCommit repository.
CODEPIPELINE
: The source code settings are specified in the source action of a pipeline in AWS
CodePipeline.
GITHUB
: The source code is in a GitHub repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
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 AWS CodeCommit repository.
CODEPIPELINE
: The source code settings are specified in the source action of a pipeline
in AWS CodePipeline.
GITHUB
: The source code is in a GitHub repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
SourceType
,
SourceType
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 AWS CodeCommit repository.
CODEPIPELINE
: The source code settings are specified in the source action of a pipeline in AWS
CodePipeline.
GITHUB
: The source code is in a GitHub repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
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 AWS CodeCommit repository.
CODEPIPELINE
: The source code settings are specified in the source action of a pipeline
in AWS CodePipeline.
GITHUB
: The source code is in a GitHub repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
SourceType
,
SourceType
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 AWS CodePipeline,
location
should not be specified. If it is specified, AWS CodePipeline ignores it. This is
because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the
source code and the build spec (for example,
https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name
).
For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
bucket-name/path/to/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 build spec. You must connect your AWS account to your GitHub account. Use the AWS 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 AWS 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 AWS CodeBuild console.) To instruct AWS 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 build spec. You must connect your AWS account to your Bitbucket account. Use the AWS 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 AWS
CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source
object, set
the auth
object's type
value to OAUTH
.
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 AWS CodePipeline,
location
should not be specified. If it is specified, AWS CodePipeline ignores it. This
is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains
the source code and the build spec (for example,
https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name
).
For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
bucket-name/path/to/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 build spec. You must connect your AWS account to your GitHub account. Use the AWS 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 AWS 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 AWS CodeBuild console.) To instruct AWS
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 build spec. You must connect your AWS account to your Bitbucket account. Use the AWS
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 AWS CodeBuild console.) To instruct AWS CodeBuild to use
this connection, in the source
object, set the auth
object's
type
value to OAUTH
.
ProjectSource.Builder gitCloneDepth(Integer gitCloneDepth)
Information about the git clone depth for the build project.
gitCloneDepth
- Information about the git clone depth for the build project.ProjectSource.Builder buildspec(String buildspec)
The build spec declaration to use for the builds in this build project.
If this value is not specified, a build spec must be included along with the source code to be built.
buildspec
- The build spec declaration to use for the builds in this build project.
If this value is not specified, a build spec must be included along with the source code to be built.
ProjectSource.Builder auth(SourceAuth auth)
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
auth
- Information about the authorization settings for AWS CodeBuild to access the source code to be
built.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
default ProjectSource.Builder auth(Consumer<SourceAuth.Builder> auth)
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
This is a convenience that creates an instance of theSourceAuth.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)
.auth
- a consumer that will call methods on SourceAuth.Builder
auth(SourceAuth)
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.
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.ProjectSource.Builder insecureSsl(Boolean insecureSsl)
Enable this flag to ignore SSL warnings while connecting to the project source code.
insecureSsl
- Enable this flag to ignore SSL warnings while connecting to the project source code.ProjectSource.Builder sourceIdentifier(String sourceIdentifier)
An identifier for this project source.
sourceIdentifier
- An identifier for this project source.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.