AWS SDK for C++  1.8.78
AWS SDK for C++
Public Member Functions | List of all members
Aws::CodeBuild::Model::ProjectSource Class Reference

#include <ProjectSource.h>

Public Member Functions

 ProjectSource ()
 
 ProjectSource (Aws::Utils::Json::JsonView jsonValue)
 
ProjectSourceoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const SourceTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const SourceType &value)
 
void SetType (SourceType &&value)
 
ProjectSourceWithType (const SourceType &value)
 
ProjectSourceWithType (SourceType &&value)
 
const Aws::StringGetLocation () const
 
bool LocationHasBeenSet () const
 
void SetLocation (const Aws::String &value)
 
void SetLocation (Aws::String &&value)
 
void SetLocation (const char *value)
 
ProjectSourceWithLocation (const Aws::String &value)
 
ProjectSourceWithLocation (Aws::String &&value)
 
ProjectSourceWithLocation (const char *value)
 
int GetGitCloneDepth () const
 
bool GitCloneDepthHasBeenSet () const
 
void SetGitCloneDepth (int value)
 
ProjectSourceWithGitCloneDepth (int value)
 
const GitSubmodulesConfigGetGitSubmodulesConfig () const
 
bool GitSubmodulesConfigHasBeenSet () const
 
void SetGitSubmodulesConfig (const GitSubmodulesConfig &value)
 
void SetGitSubmodulesConfig (GitSubmodulesConfig &&value)
 
ProjectSourceWithGitSubmodulesConfig (const GitSubmodulesConfig &value)
 
ProjectSourceWithGitSubmodulesConfig (GitSubmodulesConfig &&value)
 
const Aws::StringGetBuildspec () const
 
bool BuildspecHasBeenSet () const
 
void SetBuildspec (const Aws::String &value)
 
void SetBuildspec (Aws::String &&value)
 
void SetBuildspec (const char *value)
 
ProjectSourceWithBuildspec (const Aws::String &value)
 
ProjectSourceWithBuildspec (Aws::String &&value)
 
ProjectSourceWithBuildspec (const char *value)
 
const SourceAuthGetAuth () const
 
bool AuthHasBeenSet () const
 
void SetAuth (const SourceAuth &value)
 
void SetAuth (SourceAuth &&value)
 
ProjectSourceWithAuth (const SourceAuth &value)
 
ProjectSourceWithAuth (SourceAuth &&value)
 
bool GetReportBuildStatus () const
 
bool ReportBuildStatusHasBeenSet () const
 
void SetReportBuildStatus (bool value)
 
ProjectSourceWithReportBuildStatus (bool value)
 
const BuildStatusConfigGetBuildStatusConfig () const
 
bool BuildStatusConfigHasBeenSet () const
 
void SetBuildStatusConfig (const BuildStatusConfig &value)
 
void SetBuildStatusConfig (BuildStatusConfig &&value)
 
ProjectSourceWithBuildStatusConfig (const BuildStatusConfig &value)
 
ProjectSourceWithBuildStatusConfig (BuildStatusConfig &&value)
 
bool GetInsecureSsl () const
 
bool InsecureSslHasBeenSet () const
 
void SetInsecureSsl (bool value)
 
ProjectSourceWithInsecureSsl (bool value)
 
const Aws::StringGetSourceIdentifier () const
 
bool SourceIdentifierHasBeenSet () const
 
void SetSourceIdentifier (const Aws::String &value)
 
void SetSourceIdentifier (Aws::String &&value)
 
void SetSourceIdentifier (const char *value)
 
ProjectSourceWithSourceIdentifier (const Aws::String &value)
 
ProjectSourceWithSourceIdentifier (Aws::String &&value)
 
ProjectSourceWithSourceIdentifier (const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 36 of file ProjectSource.h.

Constructor & Destructor Documentation

◆ ProjectSource() [1/2]

Aws::CodeBuild::Model::ProjectSource::ProjectSource ( )

◆ ProjectSource() [2/2]

Aws::CodeBuild::Model::ProjectSource::ProjectSource ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AuthHasBeenSet()

bool Aws::CodeBuild::Model::ProjectSource::AuthHasBeenSet ( ) const
inline

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.

Definition at line 664 of file ProjectSource.h.

◆ BuildspecHasBeenSet()

bool Aws::CodeBuild::Model::ProjectSource::BuildspecHasBeenSet ( ) const
inline

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

Definition at line 557 of file ProjectSource.h.

◆ BuildStatusConfigHasBeenSet()

bool Aws::CodeBuild::Model::ProjectSource::BuildStatusConfigHasBeenSet ( ) const
inline

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.

Definition at line 754 of file ProjectSource.h.

◆ GetAuth()

const SourceAuth& Aws::CodeBuild::Model::ProjectSource::GetAuth ( ) const
inline

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.

Definition at line 656 of file ProjectSource.h.

◆ GetBuildspec()

const Aws::String& Aws::CodeBuild::Model::ProjectSource::GetBuildspec ( ) const
inline

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

Definition at line 542 of file ProjectSource.h.

◆ GetBuildStatusConfig()

const BuildStatusConfig& Aws::CodeBuild::Model::ProjectSource::GetBuildStatusConfig ( ) const
inline

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.

Definition at line 746 of file ProjectSource.h.

◆ GetGitCloneDepth()

int Aws::CodeBuild::Model::ProjectSource::GetGitCloneDepth ( ) const
inline

Information about the Git clone depth for the build project.

Definition at line 474 of file ProjectSource.h.

◆ GetGitSubmodulesConfig()

const GitSubmodulesConfig& Aws::CodeBuild::Model::ProjectSource::GetGitSubmodulesConfig ( ) const
inline

Information about the Git submodules configuration for the build project.

Definition at line 496 of file ProjectSource.h.

◆ GetInsecureSsl()

bool Aws::CodeBuild::Model::ProjectSource::GetInsecureSsl ( ) const
inline

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

Definition at line 793 of file ProjectSource.h.

◆ GetLocation()

const Aws::String& Aws::CodeBuild::Model::ProjectSource::GetLocation ( ) const
inline

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 buildspec file (for example, https://git-codecommit.&lt;region-ID&gt;.amazonaws.com/v1/repos/&lt;repo-name&gt;).

  • 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>/<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 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 buildspec file. 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.

Definition at line 181 of file ProjectSource.h.

◆ GetReportBuildStatus()

bool Aws::CodeBuild::Model::ProjectSource::GetReportBuildStatus ( ) const
inline

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.

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

Definition at line 707 of file ProjectSource.h.

◆ GetSourceIdentifier()

const Aws::String& Aws::CodeBuild::Model::ProjectSource::GetSourceIdentifier ( ) const
inline

An identifier for this project source.

Definition at line 817 of file ProjectSource.h.

◆ GetType()

const SourceType& Aws::CodeBuild::Model::ProjectSource::GetType ( ) const
inline

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 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 Simple Storage Service (Amazon S3) input bucket.

Definition at line 59 of file ProjectSource.h.

◆ GitCloneDepthHasBeenSet()

bool Aws::CodeBuild::Model::ProjectSource::GitCloneDepthHasBeenSet ( ) const
inline

Information about the Git clone depth for the build project.

Definition at line 479 of file ProjectSource.h.

◆ GitSubmodulesConfigHasBeenSet()

bool Aws::CodeBuild::Model::ProjectSource::GitSubmodulesConfigHasBeenSet ( ) const
inline

Information about the Git submodules configuration for the build project.

Definition at line 502 of file ProjectSource.h.

◆ InsecureSslHasBeenSet()

bool Aws::CodeBuild::Model::ProjectSource::InsecureSslHasBeenSet ( ) const
inline

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

Definition at line 799 of file ProjectSource.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::CodeBuild::Model::ProjectSource::Jsonize ( ) const

◆ LocationHasBeenSet()

bool Aws::CodeBuild::Model::ProjectSource::LocationHasBeenSet ( ) const
inline

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 buildspec file (for example, https://git-codecommit.&lt;region-ID&gt;.amazonaws.com/v1/repos/&lt;repo-name&gt;).

  • 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>/<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 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 buildspec file. 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.

Definition at line 222 of file ProjectSource.h.

◆ operator=()

ProjectSource& Aws::CodeBuild::Model::ProjectSource::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ReportBuildStatusHasBeenSet()

bool Aws::CodeBuild::Model::ProjectSource::ReportBuildStatusHasBeenSet ( ) const
inline

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.

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

Definition at line 717 of file ProjectSource.h.

◆ SetAuth() [1/2]

void Aws::CodeBuild::Model::ProjectSource::SetAuth ( const SourceAuth value)
inline

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.

Definition at line 672 of file ProjectSource.h.

◆ SetAuth() [2/2]

void Aws::CodeBuild::Model::ProjectSource::SetAuth ( SourceAuth &&  value)
inline

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.

Definition at line 680 of file ProjectSource.h.

◆ SetBuildspec() [1/3]

void Aws::CodeBuild::Model::ProjectSource::SetBuildspec ( const Aws::String value)
inline

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

Definition at line 572 of file ProjectSource.h.

◆ SetBuildspec() [2/3]

void Aws::CodeBuild::Model::ProjectSource::SetBuildspec ( Aws::String &&  value)
inline

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

Definition at line 587 of file ProjectSource.h.

◆ SetBuildspec() [3/3]

void Aws::CodeBuild::Model::ProjectSource::SetBuildspec ( const char *  value)
inline

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

Definition at line 602 of file ProjectSource.h.

◆ SetBuildStatusConfig() [1/2]

void Aws::CodeBuild::Model::ProjectSource::SetBuildStatusConfig ( const BuildStatusConfig value)
inline

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.

Definition at line 762 of file ProjectSource.h.

◆ SetBuildStatusConfig() [2/2]

void Aws::CodeBuild::Model::ProjectSource::SetBuildStatusConfig ( BuildStatusConfig &&  value)
inline

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.

Definition at line 770 of file ProjectSource.h.

◆ SetGitCloneDepth()

void Aws::CodeBuild::Model::ProjectSource::SetGitCloneDepth ( int  value)
inline

Information about the Git clone depth for the build project.

Definition at line 484 of file ProjectSource.h.

◆ SetGitSubmodulesConfig() [1/2]

void Aws::CodeBuild::Model::ProjectSource::SetGitSubmodulesConfig ( const GitSubmodulesConfig value)
inline

Information about the Git submodules configuration for the build project.

Definition at line 508 of file ProjectSource.h.

◆ SetGitSubmodulesConfig() [2/2]

void Aws::CodeBuild::Model::ProjectSource::SetGitSubmodulesConfig ( GitSubmodulesConfig &&  value)
inline

Information about the Git submodules configuration for the build project.

Definition at line 514 of file ProjectSource.h.

◆ SetInsecureSsl()

void Aws::CodeBuild::Model::ProjectSource::SetInsecureSsl ( bool  value)
inline

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

Definition at line 805 of file ProjectSource.h.

◆ SetLocation() [1/3]

void Aws::CodeBuild::Model::ProjectSource::SetLocation ( const Aws::String value)
inline

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 buildspec file (for example, https://git-codecommit.&lt;region-ID&gt;.amazonaws.com/v1/repos/&lt;repo-name&gt;).

  • 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>/<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 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 buildspec file. 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.

Definition at line 263 of file ProjectSource.h.

◆ SetLocation() [2/3]

void Aws::CodeBuild::Model::ProjectSource::SetLocation ( Aws::String &&  value)
inline

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 buildspec file (for example, https://git-codecommit.&lt;region-ID&gt;.amazonaws.com/v1/repos/&lt;repo-name&gt;).

  • 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>/<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 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 buildspec file. 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.

Definition at line 304 of file ProjectSource.h.

◆ SetLocation() [3/3]

void Aws::CodeBuild::Model::ProjectSource::SetLocation ( const char *  value)
inline

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 buildspec file (for example, https://git-codecommit.&lt;region-ID&gt;.amazonaws.com/v1/repos/&lt;repo-name&gt;).

  • 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>/<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 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 buildspec file. 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.

Definition at line 345 of file ProjectSource.h.

◆ SetReportBuildStatus()

void Aws::CodeBuild::Model::ProjectSource::SetReportBuildStatus ( bool  value)
inline

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.

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

Definition at line 727 of file ProjectSource.h.

◆ SetSourceIdentifier() [1/3]

void Aws::CodeBuild::Model::ProjectSource::SetSourceIdentifier ( const Aws::String value)
inline

An identifier for this project source.

Definition at line 827 of file ProjectSource.h.

◆ SetSourceIdentifier() [2/3]

void Aws::CodeBuild::Model::ProjectSource::SetSourceIdentifier ( Aws::String &&  value)
inline

An identifier for this project source.

Definition at line 832 of file ProjectSource.h.

◆ SetSourceIdentifier() [3/3]

void Aws::CodeBuild::Model::ProjectSource::SetSourceIdentifier ( const char *  value)
inline

An identifier for this project source.

Definition at line 837 of file ProjectSource.h.

◆ SetType() [1/2]

void Aws::CodeBuild::Model::ProjectSource::SetType ( const SourceType value)
inline

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 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 Simple Storage Service (Amazon S3) input bucket.

Definition at line 91 of file ProjectSource.h.

◆ SetType() [2/2]

void Aws::CodeBuild::Model::ProjectSource::SetType ( SourceType &&  value)
inline

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 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 Simple Storage Service (Amazon S3) input bucket.

Definition at line 107 of file ProjectSource.h.

◆ SourceIdentifierHasBeenSet()

bool Aws::CodeBuild::Model::ProjectSource::SourceIdentifierHasBeenSet ( ) const
inline

An identifier for this project source.

Definition at line 822 of file ProjectSource.h.

◆ TypeHasBeenSet()

bool Aws::CodeBuild::Model::ProjectSource::TypeHasBeenSet ( ) const
inline

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 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 Simple Storage Service (Amazon S3) input bucket.

Definition at line 75 of file ProjectSource.h.

◆ WithAuth() [1/2]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithAuth ( const SourceAuth value)
inline

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.

Definition at line 688 of file ProjectSource.h.

◆ WithAuth() [2/2]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithAuth ( SourceAuth &&  value)
inline

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.

Definition at line 696 of file ProjectSource.h.

◆ WithBuildspec() [1/3]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithBuildspec ( const Aws::String value)
inline

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

Definition at line 617 of file ProjectSource.h.

◆ WithBuildspec() [2/3]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithBuildspec ( Aws::String &&  value)
inline

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

Definition at line 632 of file ProjectSource.h.

◆ WithBuildspec() [3/3]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithBuildspec ( const char *  value)
inline

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

Definition at line 647 of file ProjectSource.h.

◆ WithBuildStatusConfig() [1/2]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithBuildStatusConfig ( const BuildStatusConfig value)
inline

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.

Definition at line 778 of file ProjectSource.h.

◆ WithBuildStatusConfig() [2/2]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithBuildStatusConfig ( BuildStatusConfig &&  value)
inline

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.

Definition at line 786 of file ProjectSource.h.

◆ WithGitCloneDepth()

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithGitCloneDepth ( int  value)
inline

Information about the Git clone depth for the build project.

Definition at line 489 of file ProjectSource.h.

◆ WithGitSubmodulesConfig() [1/2]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithGitSubmodulesConfig ( const GitSubmodulesConfig value)
inline

Information about the Git submodules configuration for the build project.

Definition at line 520 of file ProjectSource.h.

◆ WithGitSubmodulesConfig() [2/2]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithGitSubmodulesConfig ( GitSubmodulesConfig &&  value)
inline

Information about the Git submodules configuration for the build project.

Definition at line 526 of file ProjectSource.h.

◆ WithInsecureSsl()

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithInsecureSsl ( bool  value)
inline

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

Definition at line 811 of file ProjectSource.h.

◆ WithLocation() [1/3]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithLocation ( const Aws::String value)
inline

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 buildspec file (for example, https://git-codecommit.&lt;region-ID&gt;.amazonaws.com/v1/repos/&lt;repo-name&gt;).

  • 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>/<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 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 buildspec file. 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.

Definition at line 386 of file ProjectSource.h.

◆ WithLocation() [2/3]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithLocation ( Aws::String &&  value)
inline

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 buildspec file (for example, https://git-codecommit.&lt;region-ID&gt;.amazonaws.com/v1/repos/&lt;repo-name&gt;).

  • 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>/<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 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 buildspec file. 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.

Definition at line 427 of file ProjectSource.h.

◆ WithLocation() [3/3]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithLocation ( const char *  value)
inline

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 buildspec file (for example, https://git-codecommit.&lt;region-ID&gt;.amazonaws.com/v1/repos/&lt;repo-name&gt;).

  • 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>/<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 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 buildspec file. 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.

Definition at line 468 of file ProjectSource.h.

◆ WithReportBuildStatus()

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithReportBuildStatus ( bool  value)
inline

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.

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

Definition at line 737 of file ProjectSource.h.

◆ WithSourceIdentifier() [1/3]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithSourceIdentifier ( const Aws::String value)
inline

An identifier for this project source.

Definition at line 842 of file ProjectSource.h.

◆ WithSourceIdentifier() [2/3]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithSourceIdentifier ( Aws::String &&  value)
inline

An identifier for this project source.

Definition at line 847 of file ProjectSource.h.

◆ WithSourceIdentifier() [3/3]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithSourceIdentifier ( const char *  value)
inline

An identifier for this project source.

Definition at line 852 of file ProjectSource.h.

◆ WithType() [1/2]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithType ( const SourceType value)
inline

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 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 Simple Storage Service (Amazon S3) input bucket.

Definition at line 123 of file ProjectSource.h.

◆ WithType() [2/2]

ProjectSource& Aws::CodeBuild::Model::ProjectSource::WithType ( SourceType &&  value)
inline

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 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 Simple Storage Service (Amazon S3) input bucket.

Definition at line 139 of file ProjectSource.h.


The documentation for this class was generated from the following file: