/AWS1/CL_BLD=>STARTBUILDBATCH()
¶
About StartBuildBatch¶
Starts a batch build for a project.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_PROJECTNAME
TYPE /AWS1/BLDNONEMPTYSTRING
/AWS1/BLDNONEMPTYSTRING
¶
The name of the project.
Optional arguments:¶
IT_SECONDARYSOURCESOVERRIDE
TYPE /AWS1/CL_BLDPROJECTSOURCE=>TT_PROJECTSOURCES
TT_PROJECTSOURCES
¶
An array of
ProjectSource
objects that override the secondary sources defined in the batch build project.
IT_SECSOURCESVERSIONOVERRIDE
TYPE /AWS1/CL_BLDPROJECTSOURCEVRS=>TT_PROJECTSECSOURCEVERSIONS
TT_PROJECTSECSOURCEVERSIONS
¶
An array of
ProjectSourceVersion
objects that override the secondary source versions in the batch build project.
IV_SOURCEVERSION
TYPE /AWS1/BLDSTRING
/AWS1/BLDSTRING
¶
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:
- 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 examplepr/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 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 thissourceVersion
(at the build level) takes precedence.For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
IO_ARTIFACTSOVERRIDE
TYPE REF TO /AWS1/CL_BLDPROJECTARTIFACTS
/AWS1/CL_BLDPROJECTARTIFACTS
¶
An array of
ProjectArtifacts
objects that contains information about the build output artifact overrides for the build project.
IT_SECARTIFACTSOVERRIDE
TYPE /AWS1/CL_BLDPROJECTARTIFACTS=>TT_PROJECTARTIFACTSLIST
TT_PROJECTARTIFACTSLIST
¶
An array of
ProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.
IT_ENVIRONMENTVARIABLESOVE00
TYPE /AWS1/CL_BLDENVIRONMENTVARIA00=>TT_ENVIRONMENTVARIABLES
TT_ENVIRONMENTVARIABLES
¶
An array of
EnvironmentVariable
objects that override, or add to, the environment variables defined in the batch build project.
IV_SOURCETYPEOVERRIDE
TYPE /AWS1/BLDSOURCETYPE
/AWS1/BLDSOURCETYPE
¶
The source input type that overrides the source input defined in the batch build project.
IV_SOURCELOCATIONOVERRIDE
TYPE /AWS1/BLDSTRING
/AWS1/BLDSTRING
¶
A location that overrides, for this batch build, the source location defined in the batch build project.
IO_SOURCEAUTHOVERRIDE
TYPE REF TO /AWS1/CL_BLDSOURCEAUTH
/AWS1/CL_BLDSOURCEAUTH
¶
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.
IV_GITCLONEDEPTHOVERRIDE
TYPE /AWS1/BLDGITCLONEDEPTH
/AWS1/BLDGITCLONEDEPTH
¶
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.
IO_GITSUBMODULESCFGOVERRIDE
TYPE REF TO /AWS1/CL_BLDGITSUBMODULESCFG
/AWS1/CL_BLDGITSUBMODULESCFG
¶
A
GitSubmodulesConfig
object that overrides the Git submodules configuration for this batch build.
IV_BUILDSPECOVERRIDE
TYPE /AWS1/BLDSTRING
/AWS1/BLDSTRING
¶
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 Amazon Web Services 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.
IV_INSECURESSLOVERRIDE
TYPE /AWS1/BLDWRAPPERBOOLEAN
/AWS1/BLDWRAPPERBOOLEAN
¶
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.
IV_RPTBUILDBATCHSTATOVERRIDE
TYPE /AWS1/BLDWRAPPERBOOLEAN
/AWS1/BLDWRAPPERBOOLEAN
¶
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, aninvalidInputException
is thrown.The status of a build triggered by a webhook is always reported to your source provider.
IV_ENVIRONMENTTYPEOVERRIDE
TYPE /AWS1/BLDENVIRONMENTTYPE
/AWS1/BLDENVIRONMENTTYPE
¶
A container type for this batch build that overrides the one specified in the batch build project.
IV_IMAGEOVERRIDE
TYPE /AWS1/BLDNONEMPTYSTRING
/AWS1/BLDNONEMPTYSTRING
¶
The name of an image for this batch build that overrides the one specified in the batch build project.
IV_COMPUTETYPEOVERRIDE
TYPE /AWS1/BLDCOMPUTETYPE
/AWS1/BLDCOMPUTETYPE
¶
The name of a compute type for this batch build that overrides the one specified in the batch build project.
IV_CERTIFICATEOVERRIDE
TYPE /AWS1/BLDSTRING
/AWS1/BLDSTRING
¶
The name of a certificate for this batch build that overrides the one specified in the batch build project.
IO_CACHEOVERRIDE
TYPE REF TO /AWS1/CL_BLDPROJECTCACHE
/AWS1/CL_BLDPROJECTCACHE
¶
A
ProjectCache
object that specifies cache overrides.
IV_SERVICEROLEOVERRIDE
TYPE /AWS1/BLDNONEMPTYSTRING
/AWS1/BLDNONEMPTYSTRING
¶
The name of a service role for this batch build that overrides the one specified in the batch build project.
IV_PRIVILEGEDMODEOVERRIDE
TYPE /AWS1/BLDWRAPPERBOOLEAN
/AWS1/BLDWRAPPERBOOLEAN
¶
Enable this flag to override privileged mode in the batch build project.
IV_BUILDTMOUTINMINSOVERRIDE
TYPE /AWS1/BLDBUILDTIMEOUT
/AWS1/BLDBUILDTIMEOUT
¶
Overrides the build timeout specified in the batch build project.
IV_QUEUEDTMOUTINMINSOVERRIDE
TYPE /AWS1/BLDTIMEOUT
/AWS1/BLDTIMEOUT
¶
The number of minutes a batch build is allowed to be queued before it times out.
IV_ENCRYPTIONKEYOVERRIDE
TYPE /AWS1/BLDNONEMPTYSTRING
/AWS1/BLDNONEMPTYSTRING
¶
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.
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/
).
IV_IDEMPOTENCYTOKEN
TYPE /AWS1/BLDSTRING
/AWS1/BLDSTRING
¶
A unique, case sensitive identifier you provide to ensure the idempotency of the
StartBuildBatch
request. The token is included in theStartBuildBatch
request and is valid for five minutes. If you repeat theStartBuildBatch
request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
IO_LOGSCONFIGOVERRIDE
TYPE REF TO /AWS1/CL_BLDLOGSCONFIG
/AWS1/CL_BLDLOGSCONFIG
¶
A
LogsConfig
object that override the log settings defined in the batch build project.
IO_REGISTRYCREDOVERRIDE
TYPE REF TO /AWS1/CL_BLDREGISTRYCREDENTIAL
/AWS1/CL_BLDREGISTRYCREDENTIAL
¶
A
RegistryCredential
object that overrides credentials for access to a private registry.
IV_IMAGEPULLCREDSTYPEOVERR00
TYPE /AWS1/BLDIMAGEPULLCREDSTYPE
/AWS1/BLDIMAGEPULLCREDSTYPE
¶
The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:
- CODEBUILD
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
- SERVICE_ROLE
Specifies that 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 CodeBuild curated image, you must useCODEBUILD
credentials.
IO_BUILDBATCHCONFIGOVERRIDE
TYPE REF TO /AWS1/CL_BLDPROJECTBUILDBTCCFG
/AWS1/CL_BLDPROJECTBUILDBTCCFG
¶
A
BuildBatchConfigOverride
object that contains batch build configuration overrides.
IV_DEBUGSESSIONENABLED
TYPE /AWS1/BLDWRAPPERBOOLEAN
/AWS1/BLDWRAPPERBOOLEAN
¶
Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.