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

Class: Aws::CodeBuild::Types::StartBuildInput

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

{
  project_name: "NonEmptyString", # required
  source_version: "String",
  artifacts_override: {
    type: "CODEPIPELINE", # required, accepts CODEPIPELINE, S3, NO_ARTIFACTS
    location: "String",
    path: "String",
    namespace_type: "NONE", # accepts NONE, BUILD_ID
    name: "String",
    packaging: "NONE", # accepts NONE, ZIP
  },
  environment_variables_override: [
    {
      name: "NonEmptyString", # required
      value: "String", # required
      type: "PLAINTEXT", # accepts PLAINTEXT, PARAMETER_STORE
    },
  ],
  buildspec_override: "String",
  timeout_in_minutes_override: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#artifacts_overrideTypes::ProjectArtifacts

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.



1588
1589
1590
1591
1592
1593
1594
1595
1596
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1588

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :buildspec_override,
  :timeout_in_minutes_override)
  include Aws::Structure
end

#buildspec_overrideString

A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

Returns:

  • (String)


1588
1589
1590
1591
1592
1593
1594
1595
1596
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1588

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :buildspec_override,
  :timeout_in_minutes_override)
  include Aws::Structure
end

#environment_variables_overrideArray<Types::EnvironmentVariable>

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Returns:



1588
1589
1590
1591
1592
1593
1594
1595
1596
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1588

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :buildspec_override,
  :timeout_in_minutes_override)
  include Aws::Structure
end

#project_nameString

The name of the build project to start running a build.

Returns:

  • (String)


1588
1589
1590
1591
1592
1593
1594
1595
1596
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1588

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :buildspec_override,
  :timeout_in_minutes_override)
  include Aws::Structure
end

#source_versionString

A version of the build input to be built, for this build only. If not specified, the latest version will be used. 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 will be used. If not specified, the default branch's HEAD commit ID will be 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 will be used. If not specified, the default branch's HEAD commit ID will be used.

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

Returns:

  • (String)


1588
1589
1590
1591
1592
1593
1594
1595
1596
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1588

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :buildspec_override,
  :timeout_in_minutes_override)
  include Aws::Structure
end

#timeout_in_minutes_overrideInteger

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

Returns:

  • (Integer)


1588
1589
1590
1591
1592
1593
1594
1595
1596
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1588

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :buildspec_override,
  :timeout_in_minutes_override)
  include Aws::Structure
end