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
    },
  ],
  source_type_override: "CODECOMMIT", # accepts CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE
  source_location_override: "String",
  source_auth_override: {
    type: "OAUTH", # required, accepts OAUTH
    resource: "String",
  },
  git_clone_depth_override: 1,
  buildspec_override: "String",
  insecure_ssl_override: false,
  report_build_status_override: false,
  environment_type_override: "WINDOWS_CONTAINER", # accepts WINDOWS_CONTAINER, LINUX_CONTAINER
  image_override: "NonEmptyString",
  compute_type_override: "BUILD_GENERAL1_SMALL", # accepts BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE
  certificate_override: "String",
  cache_override: {
    type: "NO_CACHE", # required, accepts NO_CACHE, S3
    location: "String",
  },
  service_role_override: "NonEmptyString",
  privileged_mode_override: false,
  timeout_in_minutes_override: 1,
  idempotency_token: "String",
}

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.



1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  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)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#cache_overrideTypes::ProjectCache

A ProjectCache object specified for this build that overrides the one defined in the build project.

Returns:



1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#certificate_overrideString

The name of a certificate for this build that overrides the one specified in the build project.

Returns:

  • (String)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#compute_type_overrideString

The name of a compute type for this build that overrides the one specified in the build project.

Returns:

  • (String)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#environment_type_overrideString

A container type for this build that overrides the one specified in the build project.

Returns:

  • (String)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  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:



1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#git_clone_depth_overrideInteger

The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.

Returns:

  • (Integer)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#idempotency_tokenString

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

Returns:

  • (String)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#image_overrideString

The name of an image for this build that overrides the one specified in the build project.

Returns:

  • (String)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#insecure_ssl_overrideBoolean

Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Returns:

  • (Boolean)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#privileged_mode_overrideBoolean

Enable this flag to override privileged mode in the build project.

Returns:

  • (Boolean)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#project_nameString

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

Returns:

  • (String)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#report_build_status_overrideBoolean

Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, an invalidInputException is thrown.

Returns:

  • (Boolean)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#service_role_overrideString

The name of a service role for this build that overrides the one specified in the build project.

Returns:

  • (String)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#source_auth_overrideTypes::SourceAuth

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.

Returns:



1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#source_location_overrideString

A location that overrides for this build the source location for the one defined in the build project.

Returns:

  • (String)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end

#source_type_overrideString

A source input type for this build that overrides the source input defined in the build project

Returns:

  • (String)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  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)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  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)


1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1755

class StartBuildInput < Struct.new(
  :project_name,
  :source_version,
  :artifacts_override,
  :environment_variables_override,
  :source_type_override,
  :source_location_override,
  :source_auth_override,
  :git_clone_depth_override,
  :buildspec_override,
  :insecure_ssl_override,
  :report_build_status_override,
  :environment_type_override,
  :image_override,
  :compute_type_override,
  :certificate_override,
  :cache_override,
  :service_role_override,
  :privileged_mode_override,
  :timeout_in_minutes_override,
  :idempotency_token)
  include Aws::Structure
end