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
  secondary_sources_override: [
    {
      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",
    },
  ],
  secondary_sources_version_override: [
    {
      source_identifier: "String", # required
      source_version: "String", # 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
    override_artifact_name: false,
    encryption_disabled: false,
    artifact_identifier: "String",
  },
  secondary_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
      override_artifact_name: false,
      encryption_disabled: false,
      artifact_identifier: "String",
    },
  ],
  environment_variables_override: [
    {
      name: "NonEmptyString", # required
      value: "String", # required
      type: "PLAINTEXT", # accepts PLAINTEXT, PARAMETER_STORE, SECRETS_MANAGER
    },
  ],
  source_type_override: "CODECOMMIT", # accepts CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE, NO_SOURCE
  source_location_override: "String",
  source_auth_override: {
    type: "OAUTH", # required, accepts OAUTH
    resource: "String",
  },
  git_clone_depth_override: 1,
  git_submodules_config_override: {
    fetch_submodules: false, # required
  },
  buildspec_override: "String",
  insecure_ssl_override: false,
  report_build_status_override: false,
  environment_type_override: "WINDOWS_CONTAINER", # accepts WINDOWS_CONTAINER, LINUX_CONTAINER, LINUX_GPU_CONTAINER, ARM_CONTAINER
  image_override: "NonEmptyString",
  compute_type_override: "BUILD_GENERAL1_SMALL", # accepts BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE, BUILD_GENERAL1_2XLARGE
  certificate_override: "String",
  cache_override: {
    type: "NO_CACHE", # required, accepts NO_CACHE, S3, LOCAL
    location: "String",
    modes: ["LOCAL_DOCKER_LAYER_CACHE"], # accepts LOCAL_DOCKER_LAYER_CACHE, LOCAL_SOURCE_CACHE, LOCAL_CUSTOM_CACHE
  },
  service_role_override: "NonEmptyString",
  privileged_mode_override: false,
  timeout_in_minutes_override: 1,
  queued_timeout_in_minutes_override: 1,
  idempotency_token: "String",
  logs_config_override: {
    cloud_watch_logs: {
      status: "ENABLED", # required, accepts ENABLED, DISABLED
      group_name: "String",
      stream_name: "String",
    },
    s3_logs: {
      status: "ENABLED", # required, accepts ENABLED, DISABLED
      location: "String",
      encryption_disabled: false,
    },
  },
  registry_credential_override: {
    credential: "NonEmptyString", # required
    credential_provider: "SECRETS_MANAGER", # required, accepts SECRETS_MANAGER
  },
  image_pull_credentials_type_override: "CODEBUILD", # accepts CODEBUILD, SERVICE_ROLE
}

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.

#cache_overrideTypes::ProjectCache

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

Returns:

  • (Types::ProjectCache)

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

#certificate_overrideString

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

Returns:

  • (String)

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

#compute_type_overrideString

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

Possible values:

  • BUILD_GENERAL1_SMALL
  • BUILD_GENERAL1_MEDIUM
  • BUILD_GENERAL1_LARGE
  • BUILD_GENERAL1_2XLARGE

Returns:

  • (String)

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

#environment_type_overrideString

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

Possible values:

  • WINDOWS_CONTAINER
  • LINUX_CONTAINER
  • LINUX_GPU_CONTAINER
  • ARM_CONTAINER

Returns:

  • (String)

    A container type for this build that overrides the one specified 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.

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

    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.

#git_submodules_config_overrideTypes::GitSubmodulesConfig

Information about the Git submodules configuration for this build of an AWS CodeBuild build project.

Returns:

  • (Types::GitSubmodulesConfig)

    Information about the Git submodules configuration for this build of an AWS CodeBuild build project.

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

    A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request.

#image_overrideString

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

Returns:

  • (String)

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

#image_pull_credentials_type_overrideString

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:

  • CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild\'s service principal.

  • SERVICE_ROLE specifies that AWS CodeBuild uses your build project\'s service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.

Possible values:

  • CODEBUILD
  • SERVICE_ROLE

Returns:

  • (String)

    The type of credentials AWS CodeBuild uses to pull images in your build.

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

    Enable this flag to override the insecure SSL setting that is specified in the build project.

#logs_config_overrideTypes::LogsConfig

Log settings for this build that override the log settings defined in the build project.

Returns:

  • (Types::LogsConfig)

    Log settings for this build that override the log settings defined in the build project.

#privileged_mode_overrideBoolean

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

Returns:

  • (Boolean)

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

#project_nameString

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

Returns:

  • (String)

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

#queued_timeout_in_minutes_overrideInteger

The number of minutes a build is allowed to be queued before it times out.

Returns:

  • (Integer)

    The number of minutes a build is allowed to be queued before it times out.

#registry_credential_overrideTypes::RegistryCredential

The credentials for access to a private registry.

Returns:

#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, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

Returns:

  • (Boolean)

    Set to true to report to your source provider the status of a build\'s start and completion.

#secondary_artifacts_overrideArray<Types::ProjectArtifacts>

An array of ProjectArtifacts objects.

Returns:

#secondary_sources_overrideArray<Types::ProjectSource>

An array of ProjectSource objects.

Returns:

#secondary_sources_version_overrideArray<Types::ProjectSourceVersion>

An array of ProjectSourceVersion objects that specify one or more versions of the project\'s secondary sources to be used for this build only.

Returns:

  • (Array<Types::ProjectSourceVersion>)

    An array of ProjectSourceVersion objects that specify one or more versions of the project\'s secondary sources to be used for this build only.

#service_role_overrideString

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

Returns:

  • (String)

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

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

  • (Types::SourceAuth)

    An authorization type for this build that overrides the one defined in the build project.

#source_location_overrideString

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

Returns:

  • (String)

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

#source_type_overrideString

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

Possible values:

  • CODECOMMIT
  • CODEPIPELINE
  • GITHUB
  • S3
  • BITBUCKET
  • GITHUB_ENTERPRISE
  • NO_SOURCE

Returns:

  • (String)

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

#source_versionString

A version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, must be one of:

  • For AWS CodeCommit: the commit ID, branch, or Git tag 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.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

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

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.