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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartBuildInput as input to an Aws::Client method, you can use a vanilla 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.

Returns:

  • (Types::ProjectArtifacts)

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

#buildspec_overrideString

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

Returns:

  • (String)

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

#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:

  • (Array<Types::EnvironmentVariable>)

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

#project_nameString

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

Returns:

  • (String)

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

#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)

    A version of the build input to be built, for this build only.

#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)

    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.