/AWS1/CL_BLDPROJECT

Information about a build project.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_name TYPE /AWS1/BLDPROJECTNAME /AWS1/BLDPROJECTNAME

The name of the build project.

iv_arn TYPE /AWS1/BLDSTRING /AWS1/BLDSTRING

The Amazon Resource Name (ARN) of the build project.

iv_description TYPE /AWS1/BLDPROJECTDESCRIPTION /AWS1/BLDPROJECTDESCRIPTION

A description that makes the build project easy to identify.

io_source TYPE REF TO /AWS1/CL_BLDPROJECTSOURCE /AWS1/CL_BLDPROJECTSOURCE

Information about the build input source code for this 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 about the build output artifacts for the build project.

it_secondaryartifacts TYPE /AWS1/CL_BLDPROJECTARTIFACTS=>TT_PROJECTARTIFACTSLIST TT_PROJECTARTIFACTSLIST

An array of ProjectArtifacts objects.

io_cache TYPE REF TO /AWS1/CL_BLDPROJECTCACHE /AWS1/CL_BLDPROJECTCACHE

Information about the cache for the build project.

io_environment TYPE REF TO /AWS1/CL_BLDPROJECTENVIRONMENT /AWS1/CL_BLDPROJECTENVIRONMENT

Information about the build environment for this build project.

iv_servicerole TYPE /AWS1/BLDNONEMPTYSTRING /AWS1/BLDNONEMPTYSTRING

The 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

How long, 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. The default is 60 minutes.

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/). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

it_tags TYPE /AWS1/CL_BLDTAG=>TT_TAGLIST TT_TAGLIST

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

iv_created TYPE /AWS1/BLDTIMESTAMP /AWS1/BLDTIMESTAMP

When the build project was created, expressed in Unix time format.

iv_lastmodified TYPE /AWS1/BLDTIMESTAMP /AWS1/BLDTIMESTAMP

When the build project's settings were last modified, expressed in Unix time format.

io_webhook TYPE REF TO /AWS1/CL_BLDWEBHOOK /AWS1/CL_BLDWEBHOOK

Information about a webhook that connects repository events to a build project in CodeBuild.

io_vpcconfig TYPE REF TO /AWS1/CL_BLDVPCCONFIG /AWS1/CL_BLDVPCCONFIG

Information about the VPC configuration that CodeBuild accesses.

io_badge TYPE REF TO /AWS1/CL_BLDPROJECTBADGE /AWS1/CL_BLDPROJECTBADGE

Information about the build badge for the build project.

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, 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

A ProjectBuildBatchConfig object that defines the batch build options for the project.

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.

iv_projectvisibility TYPE /AWS1/BLDPROJECTVISIBILITYTYPE /AWS1/BLDPROJECTVISIBILITYTYPE

projectVisibility

iv_publicprojectalias TYPE /AWS1/BLDNONEMPTYSTRING /AWS1/BLDNONEMPTYSTRING

Contains the project identifier used with the public build APIs.

iv_resourceaccessrole TYPE /AWS1/BLDNONEMPTYSTRING /AWS1/BLDNONEMPTYSTRING

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

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.

---

Queryable Attributes

name

The name of the build project.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

arn

The Amazon Resource Name (ARN) of the build project.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

description

A description that makes the build project easy to identify.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

source

Information about the build input source code for this build project.

Accessible with the following methods

Method	Description
GET_SOURCE()	Getter for SOURCE

secondarySources

An array of ProjectSource objects.

Accessible with the following methods

Method	Description
GET_SECONDARYSOURCES()	Getter for SECONDARYSOURCES, with configurable default
ASK_SECONDARYSOURCES()	Getter for SECONDARYSOURCES w/ exceptions if field has no va
HAS_SECONDARYSOURCES()	Determine if SECONDARYSOURCES has a value

sourceVersion

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.

Accessible with the following methods

Method	Description
GET_SOURCEVERSION()	Getter for SOURCEVERSION, with configurable default
ASK_SOURCEVERSION()	Getter for SOURCEVERSION w/ exceptions if field has no value
HAS_SOURCEVERSION()	Determine if SOURCEVERSION has a value

secondarySourceVersions

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

Accessible with the following methods

Method	Description
GET_SECONDARYSOURCEVERSIONS()	Getter for SECONDARYSOURCEVERSIONS, with configurable defaul
ASK_SECONDARYSOURCEVERSIONS()	Getter for SECONDARYSOURCEVERSIONS w/ exceptions if field ha
HAS_SECONDARYSOURCEVERSIONS()	Determine if SECONDARYSOURCEVERSIONS has a value

artifacts

Information about the build output artifacts for the build project.

Accessible with the following methods

Method	Description
GET_ARTIFACTS()	Getter for ARTIFACTS

secondaryArtifacts

An array of ProjectArtifacts objects.

Accessible with the following methods

Method	Description
GET_SECONDARYARTIFACTS()	Getter for SECONDARYARTIFACTS, with configurable default
ASK_SECONDARYARTIFACTS()	Getter for SECONDARYARTIFACTS w/ exceptions if field has no
HAS_SECONDARYARTIFACTS()	Determine if SECONDARYARTIFACTS has a value

cache

Information about the cache for the build project.

Accessible with the following methods

Method	Description
GET_CACHE()	Getter for CACHE

environment

Information about the build environment for this build project.

Accessible with the following methods

Method	Description
GET_ENVIRONMENT()	Getter for ENVIRONMENT

serviceRole

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

Accessible with the following methods

Method	Description
GET_SERVICEROLE()	Getter for SERVICEROLE, with configurable default
ASK_SERVICEROLE()	Getter for SERVICEROLE w/ exceptions if field has no value
HAS_SERVICEROLE()	Determine if SERVICEROLE has a value

timeoutInMinutes

How long, 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. The default is 60 minutes.

Accessible with the following methods

Method	Description
GET_TIMEOUTINMINUTES()	Getter for TIMEOUTINMINUTES, with configurable default
ASK_TIMEOUTINMINUTES()	Getter for TIMEOUTINMINUTES w/ exceptions if field has no va
HAS_TIMEOUTINMINUTES()	Determine if TIMEOUTINMINUTES has a value

queuedTimeoutInMinutes

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

Accessible with the following methods

Method	Description
GET_QUEUEDTIMEOUTINMINUTES()	Getter for QUEUEDTIMEOUTINMINUTES, with configurable default
ASK_QUEUEDTIMEOUTINMINUTES()	Getter for QUEUEDTIMEOUTINMINUTES w/ exceptions if field has
HAS_QUEUEDTIMEOUTINMINUTES()	Determine if QUEUEDTIMEOUTINMINUTES has a value

encryptionKey

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/). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

Accessible with the following methods

Method	Description
GET_ENCRYPTIONKEY()	Getter for ENCRYPTIONKEY, with configurable default
ASK_ENCRYPTIONKEY()	Getter for ENCRYPTIONKEY w/ exceptions if field has no value
HAS_ENCRYPTIONKEY()	Determine if ENCRYPTIONKEY has a value

tags

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

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value

created

When the build project was created, expressed in Unix time format.

Accessible with the following methods

Method	Description
GET_CREATED()	Getter for CREATED, with configurable default
ASK_CREATED()	Getter for CREATED w/ exceptions if field has no value
HAS_CREATED()	Determine if CREATED has a value

lastModified

When the build project's settings were last modified, expressed in Unix time format.

Accessible with the following methods

Method	Description
GET_LASTMODIFIED()	Getter for LASTMODIFIED, with configurable default
ASK_LASTMODIFIED()	Getter for LASTMODIFIED w/ exceptions if field has no value
HAS_LASTMODIFIED()	Determine if LASTMODIFIED has a value

webhook

Information about a webhook that connects repository events to a build project in CodeBuild.

Accessible with the following methods

Method	Description
GET_WEBHOOK()	Getter for WEBHOOK

vpcConfig

Information about the VPC configuration that CodeBuild accesses.

Accessible with the following methods

Method	Description
GET_VPCCONFIG()	Getter for VPCCONFIG

badge

Information about the build badge for the build project.

Accessible with the following methods

Method	Description
GET_BADGE()	Getter for BADGE

logsConfig

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

Accessible with the following methods

Method	Description
GET_LOGSCONFIG()	Getter for LOGSCONFIG

fileSystemLocations

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.

Accessible with the following methods

Method	Description
GET_FILESYSTEMLOCATIONS()	Getter for FILESYSTEMLOCATIONS, with configurable default
ASK_FILESYSTEMLOCATIONS()	Getter for FILESYSTEMLOCATIONS w/ exceptions if field has no
HAS_FILESYSTEMLOCATIONS()	Determine if FILESYSTEMLOCATIONS has a value

buildBatchConfig

A ProjectBuildBatchConfig object that defines the batch build options for the project.

Accessible with the following methods

Method	Description
GET_BUILDBATCHCONFIG()	Getter for BUILDBATCHCONFIG

concurrentBuildLimit

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.

Accessible with the following methods

Method	Description
GET_CONCURRENTBUILDLIMIT()	Getter for CONCURRENTBUILDLIMIT, with configurable default
ASK_CONCURRENTBUILDLIMIT()	Getter for CONCURRENTBUILDLIMIT w/ exceptions if field has n
HAS_CONCURRENTBUILDLIMIT()	Determine if CONCURRENTBUILDLIMIT has a value

projectVisibility

projectVisibility

Accessible with the following methods

Method	Description
GET_PROJECTVISIBILITY()	Getter for PROJECTVISIBILITY, with configurable default
ASK_PROJECTVISIBILITY()	Getter for PROJECTVISIBILITY w/ exceptions if field has no v
HAS_PROJECTVISIBILITY()	Determine if PROJECTVISIBILITY has a value

publicProjectAlias

Contains the project identifier used with the public build APIs.

Accessible with the following methods

Method	Description
GET_PUBLICPROJECTALIAS()	Getter for PUBLICPROJECTALIAS, with configurable default
ASK_PUBLICPROJECTALIAS()	Getter for PUBLICPROJECTALIAS w/ exceptions if field has no
HAS_PUBLICPROJECTALIAS()	Determine if PUBLICPROJECTALIAS has a value

resourceAccessRole

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

Accessible with the following methods

Method	Description
GET_RESOURCEACCESSROLE()	Getter for RESOURCEACCESSROLE, with configurable default
ASK_RESOURCEACCESSROLE()	Getter for RESOURCEACCESSROLE w/ exceptions if field has no
HAS_RESOURCEACCESSROLE()	Determine if RESOURCEACCESSROLE has a value

autoRetryLimit

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.

Accessible with the following methods

Method	Description
GET_AUTORETRYLIMIT()	Getter for AUTORETRYLIMIT, with configurable default
ASK_AUTORETRYLIMIT()	Getter for AUTORETRYLIMIT w/ exceptions if field has no valu
HAS_AUTORETRYLIMIT()	Determine if AUTORETRYLIMIT has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_PROJECTS

TYPES TT_PROJECTS TYPE STANDARD TABLE OF REF TO /AWS1/CL_BLDPROJECT WITH DEFAULT KEY
.