@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ProjectSource extends Object implements Serializable, Cloneable, StructuredPojo
Information about the build input source code for the build project.
Constructor and Description |
---|
ProjectSource() |
Modifier and Type | Method and Description |
---|---|
ProjectSource |
clone() |
boolean |
equals(Object obj) |
SourceAuth |
getAuth()
Information about the authorization settings for CodeBuild to access the source code to be built.
|
String |
getBuildspec()
The buildspec file declaration to use for the builds in this build project.
|
BuildStatusConfig |
getBuildStatusConfig()
Contains information that defines how the build project reports the build status to the source provider.
|
Integer |
getGitCloneDepth()
Information about the Git clone depth for the build project.
|
GitSubmodulesConfig |
getGitSubmodulesConfig()
Information about the Git submodules configuration for the build project.
|
Boolean |
getInsecureSsl()
Enable this flag to ignore SSL warnings while connecting to the project source code.
|
String |
getLocation()
Information about the location of the source code to be built.
|
Boolean |
getReportBuildStatus()
Set to true to report the status of a build's start and finish to your source provider.
|
String |
getSourceIdentifier()
An identifier for this project source.
|
String |
getType()
The type of repository that contains the source code to be built.
|
int |
hashCode() |
Boolean |
isInsecureSsl()
Enable this flag to ignore SSL warnings while connecting to the project source code.
|
Boolean |
isReportBuildStatus()
Set to true to report the status of a build's start and finish to your source provider.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAuth(SourceAuth auth)
Information about the authorization settings for CodeBuild to access the source code to be built.
|
void |
setBuildspec(String buildspec)
The buildspec file declaration to use for the builds in this build project.
|
void |
setBuildStatusConfig(BuildStatusConfig buildStatusConfig)
Contains information that defines how the build project reports the build status to the source provider.
|
void |
setGitCloneDepth(Integer gitCloneDepth)
Information about the Git clone depth for the build project.
|
void |
setGitSubmodulesConfig(GitSubmodulesConfig gitSubmodulesConfig)
Information about the Git submodules configuration for the build project.
|
void |
setInsecureSsl(Boolean insecureSsl)
Enable this flag to ignore SSL warnings while connecting to the project source code.
|
void |
setLocation(String location)
Information about the location of the source code to be built.
|
void |
setReportBuildStatus(Boolean reportBuildStatus)
Set to true to report the status of a build's start and finish to your source provider.
|
void |
setSourceIdentifier(String sourceIdentifier)
An identifier for this project source.
|
void |
setType(SourceType type)
The type of repository that contains the source code to be built.
|
void |
setType(String type)
The type of repository that contains the source code to be built.
|
String |
toString()
Returns a string representation of this object.
|
ProjectSource |
withAuth(SourceAuth auth)
Information about the authorization settings for CodeBuild to access the source code to be built.
|
ProjectSource |
withBuildspec(String buildspec)
The buildspec file declaration to use for the builds in this build project.
|
ProjectSource |
withBuildStatusConfig(BuildStatusConfig buildStatusConfig)
Contains information that defines how the build project reports the build status to the source provider.
|
ProjectSource |
withGitCloneDepth(Integer gitCloneDepth)
Information about the Git clone depth for the build project.
|
ProjectSource |
withGitSubmodulesConfig(GitSubmodulesConfig gitSubmodulesConfig)
Information about the Git submodules configuration for the build project.
|
ProjectSource |
withInsecureSsl(Boolean insecureSsl)
Enable this flag to ignore SSL warnings while connecting to the project source code.
|
ProjectSource |
withLocation(String location)
Information about the location of the source code to be built.
|
ProjectSource |
withReportBuildStatus(Boolean reportBuildStatus)
Set to true to report the status of a build's start and finish to your source provider.
|
ProjectSource |
withSourceIdentifier(String sourceIdentifier)
An identifier for this project source.
|
ProjectSource |
withType(SourceType type)
The type of repository that contains the source code to be built.
|
ProjectSource |
withType(String type)
The type of repository that contains the source code to be built.
|
public void setType(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 repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
GITLAB
: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED
: The source code is in a self-managed GitLab repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon S3 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 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 repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
GITLAB
: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED
: The source code is in a self-managed GitLab repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon S3 bucket.
SourceType
public String getType()
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 repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
GITLAB
: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED
: The source code is in a self-managed GitLab repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon S3 bucket.
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 repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
GITLAB
: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED
: The source code is in a self-managed GitLab repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon S3 bucket.
SourceType
public ProjectSource withType(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 repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
GITLAB
: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED
: The source code is in a self-managed GitLab repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon S3 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 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 repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
GITLAB
: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED
: The source code is in a self-managed GitLab repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon S3 bucket.
SourceType
public void setType(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 repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
GITLAB
: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED
: The source code is in a self-managed GitLab repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon S3 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 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 repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
GITLAB
: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED
: The source code is in a self-managed GitLab repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon S3 bucket.
SourceType
public ProjectSource withType(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 repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
GITLAB
: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED
: The source code is in a self-managed GitLab repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon S3 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 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 repository.
GITHUB_ENTERPRISE
: The source code is in a GitHub Enterprise Server repository.
GITLAB
: The source code is in a GitLab repository.
GITLAB_SELF_MANAGED
: The source code is in a self-managed GitLab repository.
NO_SOURCE
: The project does not have input source code.
S3
: The source code is in an Amazon S3 bucket.
SourceType
public void setLocation(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 an GitLab or self-managed GitLab 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 GitLab
account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or
reconnect) with GitLab, on the Connections Authorize application page, choose Authorize. Then on
the CodeConnections Create GitLab connection page, choose Connect to GitLab. (After you have
connected to your GitLab account, you do not need to finish creating the build project. You can leave the
CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set
the auth
object's type
value to CODECONNECTIONS
in the source
object.
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
.
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 an GitLab or self-managed GitLab 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
GitLab account. Use the CodeBuild console to start creating a build project. When you use the console to
connect (or reconnect) with GitLab, on the Connections Authorize application page, choose
Authorize. Then on the CodeConnections Create GitLab connection page, choose Connect to
GitLab. (After you have connected to your GitLab account, you do not need to finish creating the build
project. You can leave the CodeBuild console.) To instruct CodeBuild to override the default connection
and use this connection instead, set the auth
object's type
value to
CODECONNECTIONS
in the source
object.
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
.
public String getLocation()
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 an GitLab or self-managed GitLab 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 GitLab
account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or
reconnect) with GitLab, on the Connections Authorize application page, choose Authorize. Then on
the CodeConnections Create GitLab connection page, choose Connect to GitLab. (After you have
connected to your GitLab account, you do not need to finish creating the build project. You can leave the
CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set
the auth
object's type
value to CODECONNECTIONS
in the source
object.
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
.
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 an GitLab or self-managed GitLab 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 GitLab account. Use the CodeBuild console to start creating a build project. When you use the
console to connect (or reconnect) with GitLab, on the Connections Authorize application page,
choose Authorize. Then on the CodeConnections Create GitLab connection page, choose
Connect to GitLab. (After you have connected to your GitLab account, you do not need to finish
creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to override the
default connection and use this connection instead, set the auth
object's type
value to CODECONNECTIONS
in the source
object.
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
.
public ProjectSource withLocation(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 an GitLab or self-managed GitLab 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 GitLab
account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or
reconnect) with GitLab, on the Connections Authorize application page, choose Authorize. Then on
the CodeConnections Create GitLab connection page, choose Connect to GitLab. (After you have
connected to your GitLab account, you do not need to finish creating the build project. You can leave the
CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set
the auth
object's type
value to CODECONNECTIONS
in the source
object.
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
.
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 an GitLab or self-managed GitLab 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
GitLab account. Use the CodeBuild console to start creating a build project. When you use the console to
connect (or reconnect) with GitLab, on the Connections Authorize application page, choose
Authorize. Then on the CodeConnections Create GitLab connection page, choose Connect to
GitLab. (After you have connected to your GitLab account, you do not need to finish creating the build
project. You can leave the CodeBuild console.) To instruct CodeBuild to override the default connection
and use this connection instead, set the auth
object's type
value to
CODECONNECTIONS
in the source
object.
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
.
public void setGitCloneDepth(Integer gitCloneDepth)
Information about the Git clone depth for the build project.
gitCloneDepth
- Information about the Git clone depth for the build project.public Integer getGitCloneDepth()
Information about the Git clone depth for the build project.
public ProjectSource withGitCloneDepth(Integer gitCloneDepth)
Information about the Git clone depth for the build project.
gitCloneDepth
- Information about the Git clone depth for the build project.public void setGitSubmodulesConfig(GitSubmodulesConfig gitSubmodulesConfig)
Information about the Git submodules configuration for the build project.
gitSubmodulesConfig
- Information about the Git submodules configuration for the build project.public GitSubmodulesConfig getGitSubmodulesConfig()
Information about the Git submodules configuration for the build project.
public ProjectSource withGitSubmodulesConfig(GitSubmodulesConfig gitSubmodulesConfig)
Information about the Git submodules configuration for the build project.
gitSubmodulesConfig
- Information about the Git submodules configuration for the build project.public void setBuildspec(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.
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.
public String getBuildspec()
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.
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.
public ProjectSource withBuildspec(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.
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.
public void setAuth(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.
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.
public SourceAuth getAuth()
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 information is for the CodeBuild console's use only. Your code should not get or set this information directly.
public ProjectSource withAuth(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.
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.
public void setReportBuildStatus(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, GitLab, GitLab Self Managed, 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.
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, GitLab, GitLab Self Managed, 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.
public Boolean getReportBuildStatus()
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, GitLab, GitLab Self Managed, 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.
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.
public ProjectSource withReportBuildStatus(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, GitLab, GitLab Self Managed, 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.
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, GitLab, GitLab Self Managed, 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.
public Boolean isReportBuildStatus()
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, GitLab, GitLab Self Managed, 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.
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.
public void setBuildStatusConfig(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
.
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
.public BuildStatusConfig getBuildStatusConfig()
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
.
GITHUB
, GITHUB_ENTERPRISE
,
or BITBUCKET
.public ProjectSource withBuildStatusConfig(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
.
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
.public void setInsecureSsl(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.public Boolean getInsecureSsl()
Enable this flag to ignore SSL warnings while connecting to the project source code.
public ProjectSource withInsecureSsl(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.public Boolean isInsecureSsl()
Enable this flag to ignore SSL warnings while connecting to the project source code.
public void setSourceIdentifier(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.
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.public String getSourceIdentifier()
An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
public ProjectSource withSourceIdentifier(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.
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.public String toString()
toString
in class Object
Object.toString()
public ProjectSource clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.