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

Class: Aws::CodeBuild::Types::StartBuildBatchInput

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

Overview

Note:

When passing StartBuildBatchInput 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,
      build_status_config: {
        context: "String",
        target_url: "String",
      },
      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_batch_status_override: false,
  environment_type_override: "WINDOWS_CONTAINER", # accepts WINDOWS_CONTAINER, LINUX_CONTAINER, LINUX_GPU_CONTAINER, ARM_CONTAINER, WINDOWS_SERVER_2019_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,
  build_timeout_in_minutes_override: 1,
  queued_timeout_in_minutes_override: 1,
  encryption_key_override: "NonEmptyString",
  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
  build_batch_config_override: {
    service_role: "NonEmptyString",
    combine_artifacts: false,
    restrictions: {
      maximum_builds_allowed: 1,
      compute_types_allowed: ["NonEmptyString"],
    },
    timeout_in_mins: 1,
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#artifacts_override ⇒ Types::ProjectArtifacts

An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

Returns:

  • (Types::ProjectArtifacts) —

    An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

#build_batch_config_override ⇒ Types::ProjectBuildBatchConfig

A BuildBatchConfigOverride object that contains batch build configuration overrides.

Returns:

#build_timeout_in_minutes_override ⇒ Integer

Overrides the build timeout specified in the batch build project.

Returns:

  • (Integer) —

    Overrides the build timeout specified in the batch build project.

#buildspec_override ⇒ String

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

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Returns:

  • (String) —

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

#cache_override ⇒ Types::ProjectCache

A ProjectCache object that specifies cache overrides.

Returns:

#certificate_override ⇒ String

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

Returns:

  • (String) —

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

#compute_type_override ⇒ String

The name of a compute type for this batch build that overrides the one specified in the batch 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 batch build that overrides the one specified in the batch build project.

#encryption_key_override ⇒ String

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK\'s alias (using the format alias/<alias-name>).

Returns:

  • (String) —

    The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch build project.

#environment_type_override ⇒ String

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

Possible values:

  • WINDOWS_CONTAINER
  • LINUX_CONTAINER
  • LINUX_GPU_CONTAINER
  • ARM_CONTAINER
  • WINDOWS_SERVER_2019_CONTAINER

Returns:

  • (String) —

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

#environment_variables_override ⇒ Array<Types::EnvironmentVariable>

An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

Returns:

  • (Array<Types::EnvironmentVariable>) —

    An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

#git_clone_depth_override ⇒ Integer

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

Returns:

  • (Integer) —

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

#git_submodules_config_override ⇒ Types::GitSubmodulesConfig

A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

Returns:

  • (Types::GitSubmodulesConfig) —

    A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

#idempotency_token ⇒ String

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch 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 StartBuildBatch request.

#image_override ⇒ String

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

Returns:

  • (String) —

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

#image_pull_credentials_type_override ⇒ String

The type of credentials AWS CodeBuild uses to pull images in your batch 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 batch build.

#insecure_ssl_override ⇒ Boolean

Enable this flag to override the insecure SSL setting that is specified in the batch 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 batch build project.

#logs_config_override ⇒ Types::LogsConfig

A LogsConfig object that override the log settings defined in the batch build project.

Returns:

  • (Types::LogsConfig) —

    A LogsConfig object that override the log settings defined in the batch build project.

#privileged_mode_override ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#project_name ⇒ String

The name of the project.

Returns:

  • (String) —

    The name of the project.

#queued_timeout_in_minutes_override ⇒ Integer

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

Returns:

  • (Integer) —

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

#registry_credential_override ⇒ Types::RegistryCredential

A RegistryCredential object that overrides credentials for access to a private registry.

Returns:

#report_build_batch_status_override ⇒ Boolean

Set to true to report to your source provider the status of a batch 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 batch build\'s start and completion.

#secondary_artifacts_override ⇒ Array<Types::ProjectArtifacts>

An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.

Returns:

  • (Array<Types::ProjectArtifacts>) —

    An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.

#secondary_sources_override ⇒ Array<Types::ProjectSource>

An array of ProjectSource objects that override the secondary sources defined in the batch build project.

Returns:

  • (Array<Types::ProjectSource>) —

    An array of ProjectSource objects that override the secondary sources defined in the batch build project.

#secondary_sources_version_override ⇒ Array<Types::ProjectSourceVersion>

An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.

Returns:

  • (Array<Types::ProjectSourceVersion>) —

    An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.

#service_role_override ⇒ String

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

Returns:

  • (String) —

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

#source_auth_override ⇒ Types::SourceAuth

A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project\'s source is BitBucket or GitHub.

Returns:

  • (Types::SourceAuth) —

    A SourceAuth object that overrides the one defined in the batch build project.

#source_location_override ⇒ String

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

Returns:

  • (String) —

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

#source_type_override ⇒ String

The source input type that overrides the source input defined in the batch build project.

Possible values:

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

Returns:

  • (String) —

    The source input type that overrides the source input defined in the batch build project.

#source_version ⇒ String

The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

AWS CodeCommit

The commit ID, branch, or Git tag to use.

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.

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.

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

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