You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeBuild::Types::ProjectSource

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

Note:

When making an API call, you may pass ProjectSource data as a hash:

{
  type: "CODECOMMIT", # required, accepts CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE, NO_SOURCE
  location: "String",
  git_clone_depth: 1,
  git_submodules_config: {
    fetch_submodules: false, # required
  },
  buildspec: "String",
  auth: {
    type: "OAUTH", # required, accepts OAUTH
    resource: "String",
  },
  report_build_status: false,
  insecure_ssl: false,
  source_identifier: "String",
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#authTypes::SourceAuth

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.

Returns:



2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2230

class ProjectSource < Struct.new(
  :type,
  :location,
  :git_clone_depth,
  :git_submodules_config,
  :buildspec,
  :auth,
  :report_build_status,
  :insecure_ssl,
  :source_identifier)
  include Aws::Structure
end

#buildspecString

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

If this value is not specified, a build spec must be included along with the source code to be built.

Returns:

  • (String)


2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2230

class ProjectSource < Struct.new(
  :type,
  :location,
  :git_clone_depth,
  :git_submodules_config,
  :buildspec,
  :auth,
  :report_build_status,
  :insecure_ssl,
  :source_identifier)
  include Aws::Structure
end

#git_clone_depthInteger

Information about the Git clone depth for the build project.

Returns:

  • (Integer)


2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2230

class ProjectSource < Struct.new(
  :type,
  :location,
  :git_clone_depth,
  :git_submodules_config,
  :buildspec,
  :auth,
  :report_build_status,
  :insecure_ssl,
  :source_identifier)
  include Aws::Structure
end

#git_submodules_configTypes::GitSubmodulesConfig

Information about the Git submodules configuration for the build project.



2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2230

class ProjectSource < Struct.new(
  :type,
  :location,
  :git_clone_depth,
  :git_submodules_config,
  :buildspec,
  :auth,
  :report_build_status,
  :insecure_ssl,
  :source_identifier)
  include Aws::Structure
end

#insecure_sslBoolean

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

Returns:

  • (Boolean)


2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2230

class ProjectSource < Struct.new(
  :type,
  :location,
  :git_clone_depth,
  :git_submodules_config,
  :buildspec,
  :auth,
  :report_build_status,
  :insecure_ssl,
  :source_identifier)
  include Aws::Structure
end

#locationString

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

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

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

  • For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.

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

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

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

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

Returns:

  • (String)


2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2230

class ProjectSource < Struct.new(
  :type,
  :location,
  :git_clone_depth,
  :git_submodules_config,
  :buildspec,
  :auth,
  :report_build_status,
  :insecure_ssl,
  :source_identifier)
  include Aws::Structure
end

#report_build_statusBoolean

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.

Returns:

  • (Boolean)


2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2230

class ProjectSource < Struct.new(
  :type,
  :location,
  :git_clone_depth,
  :git_submodules_config,
  :buildspec,
  :auth,
  :report_build_status,
  :insecure_ssl,
  :source_identifier)
  include Aws::Structure
end

#source_identifierString

An identifier for this project source.

Returns:

  • (String)


2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2230

class ProjectSource < Struct.new(
  :type,
  :location,
  :git_clone_depth,
  :git_submodules_config,
  :buildspec,
  :auth,
  :report_build_status,
  :insecure_ssl,
  :source_identifier)
  include Aws::Structure
end

#typeString

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

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

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

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

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

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

  • S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.

Returns:

  • (String)


2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2230

class ProjectSource < Struct.new(
  :type,
  :location,
  :git_clone_depth,
  :git_submodules_config,
  :buildspec,
  :auth,
  :report_build_status,
  :insecure_ssl,
  :source_identifier)
  include Aws::Structure
end