The #X Amz Target=CodeBuild 20161006.StartBuildBatch API from Amazon CodeBuild — 1 operation(s) for #x amz target=codebuild 20161006.startbuildbatch.
openapi: 3.0.0
info:
version: '2016-10-06'
x-release: v4
title: 'AWS CodeBuild Builds #X Amz Target=CodeBuild 20161006.StartBuildBatch 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.StartBuildBatch'
paths:
/#X-Amz-Target=CodeBuild_20161006.StartBuildBatch:
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: StartBuildBatch
description: Starts a batch build for a project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartBuildBatchOutput'
examples:
StartBuildBatch200Example:
summary: Default StartBuildBatch 200 response
x-microcks-default: true
value:
buildBatch: example-value
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
StartBuildBatch480Example:
summary: Default StartBuildBatch 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StartBuildBatch481Example:
summary: Default StartBuildBatch 481 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StartBuildBatchInput'
examples:
StartBuildBatchRequestExample:
summary: Default StartBuildBatch 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.StartBuildBatch
summary: Amazon CodeBuild Start Build Batch
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#X Amz Target=CodeBuild 20161006.StartBuildBatch'
components:
schemas:
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.
ArtifactNamespace:
type: string
enum:
- NONE
- BUILD_ID
BuildGroup:
type: object
properties:
identifier:
allOf:
- $ref: '#/components/schemas/String'
- description: Contains the identifier of the build group.
dependsOn:
allOf:
- $ref: '#/components/schemas/Identifiers'
- description: An array of strings that contain the identifiers of the build groups that this build group depends on.
ignoreFailure:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Specifies if failures in this build group can be ignored.
currentBuildSummary:
allOf:
- $ref: '#/components/schemas/BuildSummary'
- description: A <code>BuildSummary</code> object that contains a summary of the current build group.
priorBuildSummaryList:
allOf:
- $ref: '#/components/schemas/BuildSummaries'
- description: An array of <code>BuildSummary</code> objects that contain summaries of previous build groups.
description: Contains information about a batch build build group. Build groups are used to combine builds that can run in parallel, while still being able to set dependencies on other build groups.
NonEmptyString:
type: string
minLength: 1
CloudWatchLogsConfig:
type: object
required:
- status
properties:
status:
allOf:
- $ref: '#/components/schemas/LogsConfigStatusType'
- description: '<p>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</p> <ul> <li> <p> <code>ENABLED</code>: CloudWatch Logs are enabled for this build project.</p> </li> <li> <p> <code>DISABLED</code>: CloudWatch Logs are not enabled for this build project.</p> </li> </ul>'
groupName:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The group name of the logs in CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. '
streamName:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The prefix of the stream name of the CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. '
description: ' Information about CloudWatch Logs for a build project. '
StartBuildBatchInput:
type: object
required:
- projectName
title: StartBuildBatchInput
properties:
projectName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the project.
secondarySourcesOverride:
allOf:
- $ref: '#/components/schemas/ProjectSources'
- description: An array of <code>ProjectSource</code> objects that override the secondary sources defined in the batch build project.
secondarySourcesVersionOverride:
allOf:
- $ref: '#/components/schemas/ProjectSecondarySourceVersions'
- description: An array of <code>ProjectSourceVersion</code> objects that override the secondary source versions in the batch build project.
sourceVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>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:</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: An array of <code>ProjectArtifacts</code> objects that contains information about the build output artifact overrides for the build project.
secondaryArtifactsOverride:
allOf:
- $ref: '#/components/schemas/ProjectArtifactsList'
- description: An array of <code>ProjectArtifacts</code> objects that override the secondary artifacts defined in the batch build project.
environmentVariablesOverride:
allOf:
- $ref: '#/components/schemas/EnvironmentVariables'
- description: An array of <code>EnvironmentVariable</code> objects that override, or add to, the environment variables defined in the batch build project.
sourceTypeOverride:
allOf:
- $ref: '#/components/schemas/SourceType'
- description: The source input type that overrides the source input defined in the batch build project.
sourceLocationOverride:
allOf:
- $ref: '#/components/schemas/String'
- description: A location that overrides, for this batch build, the source location defined in the batch build project.
sourceAuthOverride:
allOf:
- $ref: '#/components/schemas/SourceAuth'
- description: A <code>SourceAuth</code> 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.
gitCloneDepthOverride:
allOf:
- $ref: '#/components/schemas/GitCloneDepth'
- description: 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.
gitSubmodulesConfigOverride:
allOf:
- $ref: '#/components/schemas/GitSubmodulesConfig'
- description: A <code>GitSubmodulesConfig</code> object that overrides the Git submodules configuration for this batch build.
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 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.
reportBuildBatchStatusOverride:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: <p>Set to <code>true</code> 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 <code>invalidInputException</code> is thrown. </p> <note> <p>The status of a build triggered by a webhook is always reported to your source provider. </p> </note>
environmentTypeOverride:
allOf:
- $ref: '#/components/schemas/EnvironmentType'
- description: A container type for this batch build that overrides the one specified in the batch build project.
imageOverride:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of an image for this batch build that overrides the one specified in the batch build project.
computeTypeOverride:
allOf:
- $ref: '#/components/schemas/ComputeType'
- description: The name of a compute type for this batch build that overrides the one specified in the batch build project.
certificateOverride:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of a certificate for this batch build that overrides the one specified in the batch build project.
cacheOverride:
allOf:
- $ref: '#/components/schemas/ProjectCache'
- description: A <code>ProjectCache</code> object that specifies cache overrides.
serviceRoleOverride:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of a service role for this batch build that overrides the one specified in the batch build project.
privilegedModeOverride:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: Enable this flag to override privileged mode in the batch build project.
buildTimeoutInMinutesOverride:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: Overrides the build timeout specified in the batch build project.
queuedTimeoutInMinutesOverride:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: The number of minutes a batch 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 batch 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: A <code>LogsConfig</code> object that override the log settings defined in the batch build project.
registryCredentialOverride:
allOf:
- $ref: '#/components/schemas/RegistryCredential'
- description: A <code>RegistryCredential</code> object that overrides credentials for access to a private registry.
imagePullCredentialsTypeOverride:
allOf:
- $ref: '#/components/schemas/ImagePullCredentialsType'
- description: '<p>The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values: </p> <dl> <dt>CODEBUILD</dt> <dd> <p>Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild''s service principal.</p> </dd> <dt>SERVICE_ROLE</dt> <dd> <p>Specifies that CodeBuild uses your build project''s service role. </p> </dd> </dl> <p>When using a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When using an CodeBuild curated image, you must use <code>CODEBUILD</code> credentials. </p>'
buildBatchConfigOverride:
allOf:
- $ref: '#/components/schemas/ProjectBuildBatchConfig'
- description: A <code>BuildBatchConfigOverride</code> object that contains batch build configuration overrides.
debugSessionEnabled:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: Specifies if session debugging is enabled for this batch 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>. Batch session debugging is not supported for matrix batch builds.
BuildBatchPhases:
type: array
items:
$ref: '#/components/schemas/BuildBatchPhase'
ProjectFileSystemLocation:
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/FileSystemType'
- description: ' The type of the file system. The one supported type is <code>EFS</code>. '
location:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>A string that specifies the location of the file system created by Amazon EFS. Its format is <code>efs-dns-name:/directory-path</code>. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is <code>fs-abcd1234.efs.us-west-2.amazonaws.com</code>, and its mount directory is <code>my-efs-mount-directory</code>, then the <code>location</code> is <code>fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory</code>. </p> <p>The directory path in the format <code>efs-dns-name:/directory-path</code> is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. </p>
mountPoint:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The location in the container where you mount the file system. '
identifier:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the <code>identifier</code> in all capital letters to <code>CODEBUILD_</code>. For example, if you specify <code>my_efs</code> for <code>identifier</code>, a new environment variable is create named <code>CODEBUILD_MY_EFS</code>. </p> <p> The <code>identifier</code> is used to mount your file system. </p>
mountOptions:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are <code>nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2</code>. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html">Recommended NFS Mount Options</a>. '
description: ' Information about a file system created by Amazon Elastic File System (EFS). For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">What Is Amazon Elastic File System?</a> '
ProjectArtifacts:
type: object
required:
- type
properties:
type:
allOf:
- $ref: '#/components/schemas/ArtifactsType'
- description: '<p>The type of build output artifact. Valid values include:</p> <ul> <li> <p> <code>CODEPIPELINE</code>: The build project has build output generated through CodePipeline. </p> <note> <p>The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>.</p> </note> </li> <li> <p> <code>NO_ARTIFACTS</code>: The build project does not produce any build output.</p> </li> <li> <p> <code>S3</code>: The build project stores build output in Amazon S3.</p> </li> </ul>'
location:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>Information about the build output artifact location:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</p> </li> </ul>
path:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that CodeBuild uses to name and store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, <code>path</code> is not used.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>.</p>
namespaceType:
allOf:
- $ref: '#/components/schemas/ArtifactNamespace'
- description: '<p>Along with <code>path</code> and <code>name</code>, the pattern that CodeBuild uses to determine the name and location to store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact.</p> </li> <li> <p> <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified.</p> </li> </ul> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/<build-ID>/MyArtifact.zip</code>.</p>'
name:
allOf:
- $ref: '#/components/schemas/String'
- description: <p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that CodeBuild uses to name and store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.</p> </li> </ul> <p>For example:</p> <ul> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact is stored in <code>MyArtifacts/<build-ID>/MyArtifact.zip</code>. </p> </li> <li> <p> If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in the root of the output bucket. </p> </li> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in <code>MyArtifacts/<build-ID></code>. </p> </li> </ul>
packaging:
allOf:
- $ref: '#/components/schemas/ArtifactPackaging'
- description: '<p>The type of build output artifact to create:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>NONE</code>: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</p> </li> <li> <p> <code>ZIP</code>: CodeBuild creates in the output bucket a ZIP file that contains the build output.</p> </li> </ul> </li> </ul>'
overrideArtifactName:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: ' If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. '
encryptionDisabled:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: ' Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. '
artifactIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: ' An identifier for this artifact definition. '
bucketOwnerAccess:
$ref: '#/components/schemas/BucketOwnerAccess'
description: Information about the build output artifacts for the build project.
FileSystemType:
type: string
enum:
- EFS
GitCloneDepth:
type: integer
minimum: 0
EnvironmentVariables:
type: array
items:
$ref: '#/components/schemas/EnvironmentVariable'
BucketOwnerAccess:
type: string
enum:
- NONE
- READ_ONLY
- FULL
description: <p>Specifies the bucket owner's access for objects that another account uploads to their Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has access to these objects. This property allows you to give the bucket owner access to these objects.</p> <note> <p>To use this property, your CodeBuild service role must have the <code>s3:PutBucketAcl</code> permission. This permission allows CodeBuild to modify the access control list for the bucket.</p> </note> <p>This property can be one of the following values:</p> <dl> <dt>NONE</dt> <dd> <p>The bucket owner does not have access to the objects. This is the default.</p> </dd> <dt>READ_ONLY</dt> <dd> <p>The bucket owner has read-only access to the objects. The uploading account retains ownership of the objects.</p> </dd> <dt>FULL</dt> <dd> <p>The bucket owner has full access to the objects. Object ownership is determined by the following criteria:</p> <ul> <li> <p>If the bucket is configured with the <b>Bucket owner preferred</b> setting, the bucket owner owns the objects. The uploading account will have object access as specified by the bucket's policy.</p> </li> <li> <p>Otherwise, the uploading account retains ownership of the objects.</p> </li> </ul> <p>For more information about Amazon S3 object ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of uploaded objects using S3 Object Ownership</a> in the <i>Amazon Sim
# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/openapi/amazon-codebuild-x-amz-target-codebuild-20161006-startbuildbatch-api-openapi.yml