The #X Amz Target=CodeBuild 20161006.StartBuild API from Amazon CodeBuild — 1 operation(s) for #x amz target=codebuild 20161006.startbuild.
openapi: 3.0.0
info:
version: '2016-10-06'
x-release: v4
title: 'AWS CodeBuild Builds #X Amz Target=CodeBuild 20161006.StartBuild API'
description: <fullname>CodeBuild</fullname> <p>CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the <i> <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html">CodeBuild User Guide</a>.</i> </p>
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: codebuild
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codebuild-2016-10-06.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://codebuild.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS CodeBuild multi-region endpoint
- url: https://codebuild.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS CodeBuild multi-region endpoint
- url: http://codebuild.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia)
- url: https://codebuild.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=CodeBuild 20161006.StartBuild'
paths:
/#X-Amz-Target=CodeBuild_20161006.StartBuild:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: StartBuild
description: Starts running a build.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartBuildOutput'
examples:
StartBuild200Example:
summary: Default StartBuild 200 response
x-microcks-default: true
value:
build: example-value
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
StartBuild480Example:
summary: Default StartBuild 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StartBuild481Example:
summary: Default StartBuild 481 response
x-microcks-default: true
value: example-value
'482':
description: AccountLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/AccountLimitExceededException'
examples:
StartBuild482Example:
summary: Default StartBuild 482 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StartBuildInput'
examples:
StartBuildRequestExample:
summary: Default StartBuild request
x-microcks-default: true
value:
projectName: example-resource
secondarySourcesOverride: '500123'
secondarySourcesVersionOverride: '500123'
sourceVersion: 1.0.0
artifactsOverride: '500123'
secondaryArtifactsOverride: '500123'
environmentVariablesOverride: '500123'
sourceTypeOverride: '500123'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.StartBuild
summary: Amazon CodeBuild Start Build
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=CodeBuild 20161006.StartBuild'
components:
schemas:
BuildReportArns:
type: array
items:
$ref: '#/components/schemas/String'
ArtifactPackaging:
type: string
enum:
- NONE
- ZIP
WrapperLong:
type: integer
NetworkInterface:
type: object
properties:
subnetId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ID of the subnet.
networkInterfaceId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ID of the network interface.
description: Describes a network interface.
ProjectSourceVersion:
type: object
required:
- sourceIdentifier
- sourceVersion
properties:
sourceIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: 'An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. '
sourceVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: '<p>The source version for the corresponding source identifier. If specified, must be one of:</p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>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 <code>pr/pull-request-ID</code> (for example, <code>pr/25</code>). 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.</p> </li> <li> <p>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.</p> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul> <p> For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>'
description: ' A source identifier and its corresponding version. '
VpcConfig:
type: object
properties:
vpcId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ID of the Amazon VPC.
subnets:
allOf:
- $ref: '#/components/schemas/Subnets'
- description: A list of one or more subnet IDs in your Amazon VPC.
securityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIds'
- description: A list of one or more security groups IDs in your Amazon VPC.
description: Information about the VPC configuration that CodeBuild accesses.
DebugSession:
type: object
properties:
sessionEnabled:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: Specifies if session debugging is enabled for this build.
sessionTarget:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: Contains the identifier of the Session Manager session used for the build. To work with the paused build, you open this session to examine, control, and resume the build.
description: Contains information about the debug session for a build. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>.
Build:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The unique ID for the build.
arn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The Amazon Resource Name (ARN) of the build.
buildNumber:
allOf:
- $ref: '#/components/schemas/WrapperLong'
- description: The number of the build. For each project, the <code>buildNumber</code> of its first build is <code>1</code>. The <code>buildNumber</code> of each subsequent build is incremented by <code>1</code>. If a build is deleted, the <code>buildNumber</code> of other builds does not change.
startTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the build process started, expressed in Unix time format.
endTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: When the build process ended, expressed in Unix time format.
currentPhase:
allOf:
- $ref: '#/components/schemas/String'
- description: The current build phase.
buildStatus:
allOf:
- $ref: '#/components/schemas/StatusType'
- description: '<p>The current status of the build. Valid values include:</p> <ul> <li> <p> <code>FAILED</code>: The build failed.</p> </li> <li> <p> <code>FAULT</code>: The build faulted.</p> </li> <li> <p> <code>IN_PROGRESS</code>: The build is still in progress.</p> </li> <li> <p> <code>STOPPED</code>: The build stopped.</p> </li> <li> <p> <code>SUCCEEDED</code>: The build succeeded.</p> </li> <li> <p> <code>TIMED_OUT</code>: The build timed out.</p> </li> </ul>'
sourceVersion:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: <p>Any version identifier for the version of the source code to be built. If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence. </p> <p> For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>
resolvedSourceVersion:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: <p> An identifier for the version of this build's source code. </p> <ul> <li> <p> For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. </p> </li> <li> <p> For CodePipeline, the source revision provided by CodePipeline. </p> </li> <li> <p> For Amazon S3, this does not apply. </p> </li> </ul>
projectName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the CodeBuild project.
phases:
allOf:
- $ref: '#/components/schemas/BuildPhases'
- description: Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
source:
allOf:
- $ref: '#/components/schemas/ProjectSource'
- description: Information about the source code to be built.
secondarySources:
allOf:
- $ref: '#/components/schemas/ProjectSources'
- description: ' An array of <code>ProjectSource</code> objects. '
secondarySourceVersions:
allOf:
- $ref: '#/components/schemas/ProjectSecondarySourceVersions'
- description: '<p> An array of <code>ProjectSourceVersion</code> objects. Each <code>ProjectSourceVersion</code> must be one of: </p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>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 <code>pr/pull-request-ID</code> (for example, <code>pr/25</code>). 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.</p> </li> <li> <p>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.</p> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul>'
artifacts:
allOf:
- $ref: '#/components/schemas/BuildArtifacts'
- description: Information about the output artifacts for the build.
secondaryArtifacts:
allOf:
- $ref: '#/components/schemas/BuildArtifactsList'
- description: ' An array of <code>ProjectArtifacts</code> objects. '
cache:
allOf:
- $ref: '#/components/schemas/ProjectCache'
- description: Information about the cache for the build.
environment:
allOf:
- $ref: '#/components/schemas/ProjectEnvironment'
- description: Information about the build environment for this build.
serviceRole:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of a service role used for this build.
logs:
allOf:
- $ref: '#/components/schemas/LogsLocation'
- description: Information about the build's logs in CloudWatch Logs.
timeoutInMinutes:
allOf:
- $ref: '#/components/schemas/WrapperInt'
- description: How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.
queuedTimeoutInMinutes:
allOf:
- $ref: '#/components/schemas/WrapperInt'
- description: ' The number of minutes a build is allowed to be queued before it times out. '
buildComplete:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the build is complete. True if complete; otherwise, false.
initiator:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The entity that started the build. Valid values include:</p> <ul> <li> <p>If CodePipeline started the build, the pipeline's name (for example, <code>codepipeline/my-demo-pipeline</code>).</p> </li> <li> <p>If an IAM user started the build, the user's name (for example, <code>MyUserName</code>).</p> </li> <li> <p>If the Jenkins plugin for CodeBuild started the build, the string <code>CodeBuild-Jenkins-Plugin</code>.</p> </li> </ul>
vpcConfig:
allOf:
- $ref: '#/components/schemas/VpcConfig'
- description: If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
networkInterface:
allOf:
- $ref: '#/components/schemas/NetworkInterface'
- description: Describes a network interface.
encryptionKey:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: <p>The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.</p> <note> <p> You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>).</p>
exportedEnvironmentVariables:
allOf:
- $ref: '#/components/schemas/ExportedEnvironmentVariables'
- description: <p>A list of exported environment variables for this build.</p> <p>Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see <a href="https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-variables.html">Working with variables</a> in the <i>CodePipeline User Guide</i>.</p>
reportArns:
allOf:
- $ref: '#/components/schemas/BuildReportArns'
- description: ' An array of the ARNs associated with this build''s reports. '
fileSystemLocations:
allOf:
- $ref: '#/components/schemas/ProjectFileSystemLocations'
- description: ' An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>, <code>mountPoint</code>, and <code>type</code> of a file system created using Amazon Elastic File System. '
debugSession:
allOf:
- $ref: '#/components/schemas/DebugSession'
- description: Contains information about the debug session for this build.
buildBatchArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN of the batch build that this build is a member of, if applicable.
description: Information about a build.
LogsLocation:
type: object
properties:
groupName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the CloudWatch Logs group for the build logs.
streamName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the CloudWatch Logs stream for the build logs.
deepLink:
allOf:
- $ref: '#/components/schemas/String'
- description: The URL to an individual build log in CloudWatch Logs.
s3DeepLink:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The URL to a build log in an S3 bucket. '
cloudWatchLogsArn:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The ARN of CloudWatch Logs for a build project. Its format is <code>arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}</code>. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatchlogs.html#amazoncloudwatchlogs-resources-for-iam-policies">Resources Defined by CloudWatch Logs</a>. '
s3LogsArn:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The ARN of S3 logs for a build project. Its format is <code>arn:${Partition}:s3:::${BucketName}/${ObjectName}</code>. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html#amazons3-resources-for-iam-policies">Resources Defined by Amazon S3</a>. '
cloudWatchLogs:
allOf:
- $ref: '#/components/schemas/CloudWatchLogsConfig'
- description: ' Information about CloudWatch Logs for a build project. '
s3Logs:
allOf:
- $ref: '#/components/schemas/S3LogsConfig'
- description: ' Information about S3 logs for a build project. '
description: Information about build logs in CloudWatch Logs.
CacheMode:
type: string
enum:
- LOCAL_DOCKER_LAYER_CACHE
- LOCAL_SOURCE_CACHE
- LOCAL_CUSTOM_CACHE
BuildArtifactsList:
type: array
items:
$ref: '#/components/schemas/BuildArtifacts'
minItems: 0
maxItems: 12
StartBuildInput:
type: object
required:
- projectName
title: StartBuildInput
properties:
projectName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the CodeBuild build project to start running a build.
secondarySourcesOverride:
allOf:
- $ref: '#/components/schemas/ProjectSources'
- description: ' An array of <code>ProjectSource</code> objects. '
secondarySourcesVersionOverride:
allOf:
- $ref: '#/components/schemas/ProjectSecondarySourceVersions'
- description: ' An array of <code>ProjectSourceVersion</code> objects that specify one or more versions of the project''s secondary sources to be used for this build only. '
sourceVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The version of the 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:</p> <dl> <dt>CodeCommit</dt> <dd> <p>The commit ID, branch, or Git tag to use.</p> </dd> <dt>GitHub</dt> <dd> <p>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 <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). 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.</p> </dd> <dt>Bitbucket</dt> <dd> <p>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.</p> </dd> <dt>Amazon S3</dt> <dd> <p>The version ID of the object that represents the build input ZIP file to use.</p> </dd> </dl> <p>If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>
artifactsOverride:
allOf:
- $ref: '#/components/schemas/ProjectArtifacts'
- description: Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
secondaryArtifactsOverride:
allOf:
- $ref: '#/components/schemas/ProjectArtifactsList'
- description: ' An array of <code>ProjectArtifacts</code> objects. '
environmentVariablesOverride:
allOf:
- $ref: '#/components/schemas/EnvironmentVariables'
- description: A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
sourceTypeOverride:
allOf:
- $ref: '#/components/schemas/SourceType'
- description: A source input type, for this build, that overrides the source input defined in the build project.
sourceLocationOverride:
allOf:
- $ref: '#/components/schemas/String'
- description: A location that overrides, for this build, the source location for the one defined in the build project.
sourceAuthOverride:
allOf:
- $ref: '#/components/schemas/SourceAuth'
- description: 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.
gitCloneDepthOverride:
allOf:
- $ref: '#/components/schemas/GitCloneDepth'
- description: 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.
gitSubmodulesConfigOverride:
allOf:
- $ref: '#/components/schemas/GitSubmodulesConfig'
- description: ' Information about the Git submodules configuration for this build of an CodeBuild build project. '
buildspecOverride:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.</p> <p> 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 <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). 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 <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>. </p>
insecureSslOverride:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: 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.
reportBuildStatusOverride:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: <p> 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 <code>invalidInputException</code> is thrown. </p> <p>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</p> <note> <p> The status of a build triggered by a webhook is always reported to your source provider. </p> </note>
buildStatusConfigOverride:
allOf:
- $ref: '#/components/schemas/BuildStatusConfig'
- description: Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.
environmentTypeOverride:
allOf:
- $ref: '#/components/schemas/EnvironmentType'
- description: A container type for this build that overrides the one specified in the build project.
imageOverride:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of an image for this build that overrides the one specified in the build project.
computeTypeOverride:
allOf:
- $ref: '#/components/schemas/ComputeType'
- description: The name of a compute type for this build that overrides the one specified in the build project.
certificateOverride:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of a certificate for this build that overrides the one specified in the build project.
cacheOverride:
allOf:
- $ref: '#/components/schemas/ProjectCache'
- description: A ProjectCache object specified for this build that overrides the one defined in the build project.
serviceRoleOverride:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of a service role for this build that overrides the one specified in the build project.
privilegedModeOverride:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: Enable this flag to override privileged mode in the build project.
timeoutInMinutesOverride:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: 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.
queuedTimeoutInMinutesOverride:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: ' The number of minutes a build is allowed to be queued before it times out. '
encryptionKeyOverride:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: <p>The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.</p> <note> <p> You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>).</p>
logsConfigOverride:
allOf:
- $ref: '#/components/schemas/LogsConfig'
- description: ' Log settings for this build that override the log settings defined in the build project. '
registryCredentialOverride:
allOf:
- $ref: '#/components/schemas/RegistryCredential'
- desc
# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/openapi/amazon-codebuild-x-amz-target-codebuild-20161006-startbuild-api-openapi.yml