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

Class: Aws::CodeBuild::Types::ProjectSourceVersion

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 ProjectSourceVersion data as a hash:

{
  source_identifier: "String", # required
  source_version: "String", # required
}

A source identifier and its corresponding version.

Instance Attribute Summary collapse

Instance Attribute Details

#source_identifierString

An identifier for a source in the build project.

Returns:

  • (String)


2289
2290
2291
2292
2293
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2289

class ProjectSourceVersion < Struct.new(
  :source_identifier,
  :source_version)
  include Aws::Structure
end

#source_versionString

The source version for the corresponding source identifier. If specified, must be one of:

  • For AWS CodeCommit: the commit ID to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

Returns:

  • (String)


2289
2290
2291
2292
2293
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 2289

class ProjectSourceVersion < Struct.new(
  :source_identifier,
  :source_version)
  include Aws::Structure
end