Struct aws_sdk_codebuild::types::ProjectSource

#[non_exhaustive]
pub struct ProjectSource {
    pub type: SourceType,
    pub location: Option<String>,
    pub git_clone_depth: Option<i32>,
    pub git_submodules_config: Option<GitSubmodulesConfig>,
    pub buildspec: Option<String>,
    pub auth: Option<SourceAuth>,
    pub report_build_status: Option<bool>,
    pub build_status_config: Option<BuildStatusConfig>,
    pub insecure_ssl: Option<bool>,
    pub source_identifier: Option<String>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: SourceType

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

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

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

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

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

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

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

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

location: Option<String>

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. .amazonaws.com/v1/repos/ ).

• 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, / / .zip ).

  • The path to the folder that contains the source code (for example, / / / ).

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

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

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

git_clone_depth: Option<i32>

Information about the Git clone depth for the build project.

git_submodules_config: Option<GitSubmodulesConfig>

Information about the Git submodules configuration for the build project.

buildspec: Option<String>

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.

auth: Option<SourceAuth>

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.

report_build_status: Option<bool>

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

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

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

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

build_status_config: Option<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.

insecure_ssl: Option<bool>

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

source_identifier: Option<String>

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

Implementations

impl ProjectSource

pub fn type(&self) -> &SourceType

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

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

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

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

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

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

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

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

pub fn location(&self) -> Option<&str>

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. .amazonaws.com/v1/repos/ ).

• 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, / / .zip ).

  • The path to the folder that contains the source code (for example, / / / ).

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

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

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

pub fn git_clone_depth(&self) -> Option<i32>

Information about the Git clone depth for the build project.

pub fn git_submodules_config(&self) -> Option<&GitSubmodulesConfig>

Information about the Git submodules configuration for the build project.

pub fn buildspec(&self) -> Option<&str>

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.

pub fn auth(&self) -> Option<&SourceAuth>

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.

pub fn report_build_status(&self) -> Option<bool>

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

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

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

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

pub fn build_status_config(&self) -> Option<&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.

pub fn insecure_ssl(&self) -> Option<bool>

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

pub fn source_identifier(&self) -> Option<&str>

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

impl ProjectSource

pub fn builder() -> ProjectSourceBuilder

Creates a new builder-style object to manufacture ProjectSource.

Trait Implementations

impl Clone for ProjectSource

fn clone(&self) -> ProjectSource

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProjectSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ProjectSource

fn eq(&self, other: &ProjectSource) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProjectSource