Skip to content

/AWS1/CL_BLD=>UPDATEPROJECT()

About UpdateProject

Changes the settings of a build project.

Method Signature

IMPORTING

Required arguments:

IV_NAME TYPE /AWS1/BLDNONEMPTYSTRING /AWS1/BLDNONEMPTYSTRING

The name of the build project.

You cannot change a build project's name.

Optional arguments:

IV_DESCRIPTION TYPE /AWS1/BLDPROJECTDESCRIPTION /AWS1/BLDPROJECTDESCRIPTION

A new or replacement description of the build project.

IO_SOURCE TYPE REF TO /AWS1/CL_BLDPROJECTSOURCE /AWS1/CL_BLDPROJECTSOURCE

Information to be changed about the build input source code for the build project.

IT_SECONDARYSOURCES TYPE /AWS1/CL_BLDPROJECTSOURCE=>TT_PROJECTSOURCES TT_PROJECTSOURCES

An array of ProjectSource objects.

IV_SOURCEVERSION TYPE /AWS1/BLDSTRING /AWS1/BLDSTRING

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

  • For CodeCommit: the commit ID, branch, or Git tag to use.

  • 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 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.

  • For GitLab: the commit ID, branch, or Git tag to use.

  • 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.

  • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

IT_SECONDARYSOURCEVERSIONS TYPE /AWS1/CL_BLDPROJECTSOURCEVRS=>TT_PROJECTSECSOURCEVERSIONS TT_PROJECTSECSOURCEVERSIONS

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

IO_ARTIFACTS TYPE REF TO /AWS1/CL_BLDPROJECTARTIFACTS /AWS1/CL_BLDPROJECTARTIFACTS

Information to be changed about the build output artifacts for the build project.

IT_SECONDARYARTIFACTS TYPE /AWS1/CL_BLDPROJECTARTIFACTS=>TT_PROJECTARTIFACTSLIST TT_PROJECTARTIFACTSLIST

An array of ProjectArtifact objects.

IO_CACHE TYPE REF TO /AWS1/CL_BLDPROJECTCACHE /AWS1/CL_BLDPROJECTCACHE

Stores recently used information so that it can be quickly accessed at a later time.

IO_ENVIRONMENT TYPE REF TO /AWS1/CL_BLDPROJECTENVIRONMENT /AWS1/CL_BLDPROJECTENVIRONMENT

Information to be changed about the build environment for the build project.

IV_SERVICEROLE TYPE /AWS1/BLDNONEMPTYSTRING /AWS1/BLDNONEMPTYSTRING

The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

IV_TIMEOUTINMINUTES TYPE /AWS1/BLDBUILDTIMEOUT /AWS1/BLDBUILDTIMEOUT

The replacement value in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.

IV_QUEUEDTIMEOUTINMINUTES TYPE /AWS1/BLDTIMEOUT /AWS1/BLDTIMEOUT

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

IV_ENCRYPTIONKEY TYPE /AWS1/BLDNONEMPTYSTRING /AWS1/BLDNONEMPTYSTRING

The Key Management Service customer master key (CMK) to be used for encrypting 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/).

IT_TAGS TYPE /AWS1/CL_BLDTAG=>TT_TAGLIST TT_TAGLIST

An updated list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

IO_VPCCONFIG TYPE REF TO /AWS1/CL_BLDVPCCONFIG /AWS1/CL_BLDVPCCONFIG

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

IV_BADGEENABLED TYPE /AWS1/BLDWRAPPERBOOLEAN /AWS1/BLDWRAPPERBOOLEAN

Set this to true to generate a publicly accessible URL for your project's build badge.

IO_LOGSCONFIG TYPE REF TO /AWS1/CL_BLDLOGSCONFIG /AWS1/CL_BLDLOGSCONFIG

Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.

IT_FILESYSTEMLOCATIONS TYPE /AWS1/CL_BLDPROJECTFILESYSTE00=>TT_PROJECTFILESYSTEMLOCATIONS TT_PROJECTFILESYSTEMLOCATIONS

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

IO_BUILDBATCHCONFIG TYPE REF TO /AWS1/CL_BLDPROJECTBUILDBTCCFG /AWS1/CL_BLDPROJECTBUILDBTCCFG

buildBatchConfig

IV_CONCURRENTBUILDLIMIT TYPE /AWS1/BLDWRAPPERINT /AWS1/BLDWRAPPERINT

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

To remove this limit, set this value to -1.

IV_AUTORETRYLIMIT TYPE /AWS1/BLDWRAPPERINT /AWS1/BLDWRAPPERINT

The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the RetryBuild API to automatically retry your build for up to 2 additional times.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_BLDUPDPROJECTOUTPUT /AWS1/CL_BLDUPDPROJECTOUTPUT