Amazon CodeBuild · JSON Structure

Amazon Codebuild Project Build Batch Config Structure

Contains configuration information about a batch build project.

Type: object Properties: 5
AmazonCI/CDBuildContinuous IntegrationDevOpsTesting

ProjectBuildBatchConfig is a JSON Structure definition published by Amazon CodeBuild, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

serviceRole combineArtifacts restrictions timeoutInMins batchReportMode

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/json-structure/amazon-codebuild-project-build-batch-config-structure.json",
  "name": "ProjectBuildBatchConfig",
  "description": "Contains configuration information about a batch build project.",
  "type": "object",
  "properties": {
    "serviceRole": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "Specifies the service role ARN for the batch build project."
        }
      ]
    },
    "combineArtifacts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WrapperBoolean"
        },
        {
          "description": "Specifies if the build artifacts for the batch build should be combined into a single artifact location."
        }
      ]
    },
    "restrictions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BatchRestrictions"
        },
        {
          "description": "A <code>BatchRestrictions</code> object that specifies the restrictions for the batch build."
        }
      ]
    },
    "timeoutInMins": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WrapperInt"
        },
        {
          "description": "Specifies the maximum amount of time, in minutes, that the batch build must be completed in."
        }
      ]
    },
    "batchReportMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BatchReportModeType"
        },
        {
          "description": "<p>Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.</p> <dl> <dt>REPORT_AGGREGATED_BATCH</dt> <dd> <p>(Default) Aggregate all of the build statuses into a single status report.</p> </dd> <dt>REPORT_INDIVIDUAL_BUILDS</dt> <dd> <p>Send a separate status report for each individual build.</p> </dd> </dl>"
        }
      ]
    }
  }
}