Integer maximumBuildsAllowed
Specifies the maximum number of builds allowed.
List<E> computeTypesAllowed
An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the AWS CodeBuild User Guide for these values.
String id
The unique ID for the build.
String arn
The Amazon Resource Name (ARN) of the build.
Long buildNumber
The number of the build. For each project, the buildNumber of its first build is 1. The
buildNumber of each subsequent build is incremented by 1. If a build is deleted, the
buildNumber of other builds does not change.
Date startTime
When the build process started, expressed in Unix time format.
Date endTime
When the build process ended, expressed in Unix time format.
String currentPhase
The current build phase.
String buildStatus
The current status of the build. Valid values include:
FAILED: The build failed.
FAULT: The build faulted.
IN_PROGRESS: The build is still in progress.
STOPPED: The build stopped.
SUCCEEDED: The build succeeded.
TIMED_OUT: The build timed out.
String sourceVersion
Any version identifier for the version of the source code to be built. If sourceVersion is specified
at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
String resolvedSourceVersion
An identifier for the version of this build's source code.
For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For AWS CodePipeline, the source revision provided by AWS CodePipeline.
For Amazon S3, this does not apply.
String projectName
The name of the AWS CodeBuild project.
List<E> phases
Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
ProjectSource source
Information about the source code to be built.
List<E> secondarySources
An array of ProjectSource objects.
List<E> secondarySourceVersions
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For AWS 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 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.
BuildArtifacts artifacts
Information about the output artifacts for the build.
List<E> secondaryArtifacts
An array of ProjectArtifacts objects.
ProjectCache cache
Information about the cache for the build.
ProjectEnvironment environment
Information about the build environment for this build.
String serviceRole
The name of a service role used for this build.
LogsLocation logs
Information about the build's logs in Amazon CloudWatch Logs.
Integer timeoutInMinutes
How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.
Integer queuedTimeoutInMinutes
The number of minutes a build is allowed to be queued before it times out.
Boolean buildComplete
Whether the build is complete. True if complete; otherwise, false.
String initiator
The entity that started the build. Valid values include:
If AWS CodePipeline started the build, the pipeline's name (for example,
codepipeline/my-demo-pipeline).
If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example,
MyUserName).
If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
VpcConfig vpcConfig
If your AWS 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 networkInterface
Describes a network interface.
String encryptionKey
The AWS Key Management Service (AWS KMS) 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/<alias-name>).
List<E> exportedEnvironmentVariables
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with AWS CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the AWS CodePipeline User Guide.
List<E> reportArns
An array of the ARNs associated with this build's reports.
List<E> 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.
DebugSession debugSession
Contains information about the debug session for this build.
String buildBatchArn
The ARN of the batch build that this build is a member of, if applicable.
String location
Information about the location of the build artifacts.
String sha256sum
The SHA-256 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is available only if the build project's packaging value is set to ZIP.
String md5sum
The MD5 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is available only if the build project's packaging value is set to ZIP.
Boolean overrideArtifactName
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.
Boolean encryptionDisabled
Information that tells you if encryption for build artifacts is disabled.
String artifactIdentifier
An identifier for this artifact definition.
String bucketOwnerAccess
String id
The identifier of the batch build.
String arn
The ARN of the batch build.
Date startTime
The date and time that the batch build started.
Date endTime
The date and time that the batch build ended.
String currentPhase
The current phase of the batch build.
String buildBatchStatus
The status of the batch build.
String sourceVersion
The identifier of the version of the source code to be built.
String resolvedSourceVersion
The identifier of the resolved version of this batch build's source code.
For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For AWS CodePipeline, the source revision provided by AWS CodePipeline.
For Amazon S3, this does not apply.
String projectName
The name of the batch build project.
List<E> phases
An array of BuildBatchPhase objects the specify the phases of the batch build.
ProjectSource source
List<E> secondarySources
An array of ProjectSource objects that define the sources for the batch build.
List<E> secondarySourceVersions
An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For AWS 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 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.
BuildArtifacts artifacts
A BuildArtifacts object the defines the build artifacts for this batch build.
List<E> secondaryArtifacts
An array of BuildArtifacts objects the define the build artifacts for this batch build.
ProjectCache cache
ProjectEnvironment environment
String serviceRole
The name of a service role used for builds in the batch.
LogsConfig logConfig
Integer buildTimeoutInMinutes
Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.
Integer queuedTimeoutInMinutes
Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.
Boolean complete
Indicates if the batch build is complete.
String initiator
The entity that started the batch build. Valid values include:
If AWS CodePipeline started the build, the pipeline's name (for example,
codepipeline/my-demo-pipeline).
If an AWS Identity and Access Management (IAM) user started the build, the user's name.
If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
VpcConfig vpcConfig
String encryptionKey
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the batch 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/<alias-name>).
Long buildBatchNumber
The number of the batch build. For each project, the buildBatchNumber of its first batch build is
1. The buildBatchNumber of each subsequent batch build is incremented by 1
. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.
List<E> fileSystemLocations
An array of ProjectFileSystemLocation objects for the batch build project. A
ProjectFileSystemLocation object specifies the identifier, location,
mountOptions, mountPoint, and type of a file system created using Amazon
Elastic File System.
ProjectBuildBatchConfig buildBatchConfig
List<E> buildGroups
An array of BuildGroup objects that define the build groups for the batch build.
Boolean debugSessionEnabled
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.
String status
The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved.
String phaseType
The name of the batch build phase. Valid values include:
Build output artifacts are being combined and uploaded to the output location.
The batch build specification is being downloaded.
One or more of the builds failed.
The batch build is in progress.
The batch build was stopped.
The btach build has been submitted.
The batch build succeeded.
String phaseStatus
The current status of the batch build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build has been submitted and is queued behind other submitted builds.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
Date startTime
When the batch build phase started, expressed in Unix time format.
Date endTime
When the batch build phase ended, expressed in Unix time format.
Long durationInSeconds
How long, in seconds, between the starting and ending times of the batch build's phase.
List<E> contexts
Additional information about the batch build phase. Especially to help troubleshoot a failed batch build.
String identifier
Contains the identifier of the build group.
List<E> dependsOn
An array of strings that contain the identifiers of the build groups that this build group depends on.
Boolean ignoreFailure
Specifies if failures in this build group can be ignored.
BuildSummary currentBuildSummary
A BuildSummary object that contains a summary of the current build group.
List<E> priorBuildSummaryList
An array of BuildSummary objects that contain summaries of previous build groups.
String phaseType
The name of the build phase. Valid values include:
BUILD: Core build activities typically occur in this build phase.
COMPLETED: The build has been completed.
DOWNLOAD_SOURCE: Source code is being downloaded in this build phase.
FINALIZING: The build process is completing in this build phase.
INSTALL: Installation activities typically occur in this build phase.
POST_BUILD: Post-build activities typically occur in this build phase.
PRE_BUILD: Pre-build activities typically occur in this build phase.
PROVISIONING: The build environment is being set up.
QUEUED: The build has been submitted and is queued behind other submitted builds.
SUBMITTED: The build has been submitted.
UPLOAD_ARTIFACTS: Build output artifacts are being uploaded to the output location.
String phaseStatus
The current status of the build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build has been submitted and is queued behind other submitted builds.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
Date startTime
When the build phase started, expressed in Unix time format.
Date endTime
When the build phase ended, expressed in Unix time format.
Long durationInSeconds
How long, in seconds, between the starting and ending times of the build's phase.
List<E> contexts
Additional information about a build phase, especially to help troubleshoot a failed build.
String context
Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
This parameter is used for the name parameter in the Bitbucket commit status. For more information,
see build in the Bitbucket API documentation.
This parameter is used for the context parameter in the GitHub commit status. For more information,
see Create a commit status
in the GitHub developer guide.
String targetUrl
Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
This parameter is used for the url parameter in the Bitbucket commit status. For more information,
see build in the Bitbucket API documentation.
This parameter is used for the target_url parameter in the GitHub commit status. For more
information, see Create a commit
status in the GitHub developer guide.
String arn
The batch build ARN.
Date requestedOn
When the build was started, expressed in Unix time format.
String buildStatus
The status of the build group.
The build group failed.
The build group faulted.
The build group is still in progress.
The build group stopped.
The build group succeeded.
The build group timed out.
ResolvedArtifact primaryArtifact
A ResolvedArtifact object that represents the primary build artifacts for the build group.
List<E> secondaryArtifacts
An array of ResolvedArtifact objects that represents the secondary build artifacts for the build
group.
String status
The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:
ENABLED: Amazon CloudWatch Logs are enabled for this build project.
DISABLED: Amazon CloudWatch Logs are not enabled for this build project.
String groupName
The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
String streamName
The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.
String id
The identifier of the code coverage report.
String reportARN
The ARN of the report.
String filePath
The path of the test report file.
Double lineCoveragePercentage
The percentage of lines that are covered by your tests.
Integer linesCovered
The number of lines that are covered by your tests.
Integer linesMissed
The number of lines that are not covered by your tests.
Double branchCoveragePercentage
The percentage of branches that are covered by your tests.
Integer branchesCovered
The number of conditional branches that are covered by your tests.
Integer branchesMissed
The number of conditional branches that are not covered by your tests.
Date expired
The date and time that the tests were run.
Double lineCoveragePercentage
The percentage of lines that are covered by your tests.
Integer linesCovered
The number of lines that are covered by your tests.
Integer linesMissed
The number of lines that are not covered by your tests.
Double branchCoveragePercentage
The percentage of branches that are covered by your tests.
Integer branchesCovered
The number of conditional branches that are covered by your tests.
Integer branchesMissed
The number of conditional branches that are not covered by your tests.
String name
The name of the build project.
String description
A description that makes the build project easy to identify.
ProjectSource source
Information about the build input source code for the build project.
List<E> secondarySources
An array of ProjectSource objects.
String 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 AWS 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 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 AWS CodeBuild User Guide.
List<E> secondarySourceVersions
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at
the build level, then they take precedence over these secondarySourceVersions (at the project
level).
ProjectArtifacts artifacts
Information about the build output artifacts for the build project.
List<E> secondaryArtifacts
An array of ProjectArtifacts objects.
ProjectCache cache
Stores recently used information so that it can be quickly accessed at a later time.
ProjectEnvironment environment
Information about the build environment for the build project.
String serviceRole
The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
Integer timeoutInMinutes
How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.
Integer queuedTimeoutInMinutes
The number of minutes a build is allowed to be queued before it times out.
String encryptionKey
The AWS Key Management Service (AWS KMS) 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/<alias-name>).
List<E> tags
A list of tag key and value pairs associated with this build project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
VpcConfig vpcConfig
VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
Boolean badgeEnabled
Set this to true to generate a publicly accessible URL for your project's build badge.
LogsConfig logsConfig
Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.
List<E> 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.
ProjectBuildBatchConfig buildBatchConfig
A ProjectBuildBatchConfig object that defines the batch build options for the project.
Integer 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.
Project project
Information about the build project that was created.
String name
The name of the report group.
String type
The type of report group.
ReportExportConfig exportConfig
A ReportExportConfig object that contains information about where the report group test results are
exported.
List<E> tags
A list of tag key and value pairs associated with this report group.
These tags are available for use by AWS services that support AWS CodeBuild report group tags.
ReportGroup reportGroup
Information about the report group that was created.
String projectName
The name of the AWS CodeBuild project.
String branchFilter
A regular expression used to determine which repository branches are built when a webhook is triggered. If the
name of a branch matches the regular expression, then it is built. If branchFilter is empty, then
all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
List<E> filterGroups
An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least
one WebhookFilter in the array must specify EVENT as its type.
For a build to be triggered, at least one filter group in the filterGroups array must pass. For a
filter group to pass, each of its filters must pass.
String buildType
Specifies the type of build this webhook will trigger.
Webhook webhook
Information about a webhook that connects repository events to a build project in AWS CodeBuild.
Boolean sessionEnabled
Specifies if session debugging is enabled for this build.
String sessionTarget
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.
String id
The identifier of the batch build to delete.
String name
The name of the build project.
String arn
The ARN of the report group to delete.
Boolean deleteReports
If true, deletes any reports that belong to a report group before deleting the report group.
If false, you must delete any reports in the report group. Use ListReportsForReportGroup to get the reports in a report group. Use DeleteReport to delete
the reports. If you call DeleteReportGroup for a report group that contains one or more reports, an
exception is thrown.
String arn
The ARN of the report to delete.
String resourceArn
The ARN of the resource that is associated with the resource policy.
String arn
The Amazon Resource Name (ARN) of the token.
String arn
The Amazon Resource Name (ARN) of the token.
String projectName
The name of the AWS CodeBuild project.
String reportArn
The ARN of the report for which test cases are returned.
String nextToken
The nextToken value returned from a previous call to DescribeCodeCoverages. This
specifies the next item to return. To return the beginning of the list, exclude this parameter.
Integer maxResults
The maximum number of results to return.
String sortOrder
Specifies if the results are sorted in ascending or descending order.
String sortBy
Specifies how the results are sorted. Possible values are:
The results are sorted by file path.
The results are sorted by the percentage of lines that are covered.
Double minLineCoveragePercentage
The minimum line coverage percentage to report.
Double maxLineCoveragePercentage
The maximum line coverage percentage to report.
String reportArn
The ARN of the report for which test cases are returned.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
Integer maxResults
The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in
the list of returned TestCase objects. The default value is 100.
TestCaseFilter filter
A TestCaseFilter object used to filter the returned reports.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
List<E> testCases
The returned list of test cases.
String name
The name or key of the environment variable.
String value
The value of the environment variable.
We strongly discourage the use of PLAINTEXT environment variables to store sensitive values,
especially AWS secret key IDs and secret access keys. PLAINTEXT environment variables can be
displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI). For
sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or
SECRETS_MANAGER.
String type
The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. To
learn how to specify a parameter store environment variable, see env/parameter-store in the AWS CodeBuild User Guide.
PLAINTEXT: An environment variable in plain text format. This is the default value.
SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager. To learn how to specify a
secrets manager environment variable, see env/secrets-manager in the AWS CodeBuild User Guide.
String reportGroupArn
The ARN of the report group that contains the reports to analyze.
Integer numOfReports
The number of reports to analyze. This operation always retrieves the most recent reports.
If this parameter is omitted, the most recent 100 reports are analyzed.
String trendField
The test report value to accumulate. This must be one of the following values:
Accumulate the test run times for the specified reports.
Accumulate the percentage of tests that passed for the specified test reports.
Accumulate the total number of tests for the specified test reports.
Accumulate the branch coverage percentages for the specified test reports.
Accumulate the branches covered values for the specified test reports.
Accumulate the branches missed values for the specified test reports.
Accumulate the line coverage percentages for the specified test reports.
Accumulate the lines covered values for the specified test reports.
Accumulate the lines not covered values for the specified test reports.
ReportGroupTrendStats stats
Contains the accumulated trend data.
List<E> rawData
An array that contains the raw data for each report.
String resourceArn
The ARN of the resource that is associated with the resource policy.
String policy
The resource policy for the resource identified by the input ARN parameter.
Boolean fetchSubmodules
Set to true to fetch Git submodules for your AWS CodeBuild build project.
String username
The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types
of source providers or connections.
String token
For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.
String serverType
The source provider used for this project.
String authType
The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the AWS CodeBuild console.
Boolean shouldOverwrite
Set to false to prevent overwriting the repository source credentials. Set to true to
overwrite the repository source credentials. The default value is true.
String arn
The Amazon Resource Name (ARN) of the token.
String projectName
The name of the AWS CodeBuild build project that the cache is reset for.
String projectName
The name of the project.
BuildBatchFilter filter
A BuildBatchFilter object that specifies the filters for the search.
Integer maxResults
The maximum number of results to return.
String sortOrder
Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.
String nextToken
The nextToken value returned from a previous call to ListBuildBatchesForProject. This
specifies the next item to return. To return the beginning of the list, exclude this parameter.
BuildBatchFilter filter
A BuildBatchFilter object that specifies the filters for the search.
Integer maxResults
The maximum number of results to return.
String sortOrder
Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.
String nextToken
The nextToken value returned from a previous call to ListBuildBatches. This specifies
the next item to return. To return the beginning of the list, exclude this parameter.
String projectName
The name of the AWS CodeBuild project.
String sortOrder
The order to list results in. The results are sorted by build number, not the build identifier.
Valid values include:
ASCENDING: List the build IDs in ascending order by build ID.
DESCENDING: List the build IDs in descending order by build ID.
If the project has more than 100 builds, setting the sort order will result in an error.
String nextToken
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
List<E> ids
A list of build IDs for the specified build project, with each build ID representing a single build.
String nextToken
If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
String sortOrder
The order to list build IDs. Valid values include:
ASCENDING: List the build IDs in ascending order by build ID.
DESCENDING: List the build IDs in descending order by build ID.
String nextToken
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
List<E> ids
A list of build IDs, with each build ID representing a single build.
String nextToken
If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
String sortBy
The criterion to be used to list build project names. Valid values include:
CREATED_TIME: List based on when each build project was created.
LAST_MODIFIED_TIME: List based on when information about each build project was last changed.
NAME: List based on each build project's name.
Use sortOrder to specify in what order to list the build project names based on the preceding
criteria.
String sortOrder
The order in which to list build projects. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
Use sortBy to specify the criterion to be used to list build project names.
String nextToken
During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
String nextToken
If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.
List<E> projects
The list of build project names, with each build project name representing a single build project.
String sortOrder
Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and
DESCENDING.
String sortBy
The criterion to be used to list build report groups. Valid values include:
CREATED_TIME: List based on when each report group was created.
LAST_MODIFIED_TIME: List based on when each report group was last changed.
NAME: List based on each report group's name.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
Integer maxResults
The maximum number of paginated report groups returned per response. Use nextToken to iterate pages
in the list of returned ReportGroup objects. The default value is 100.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
List<E> reportGroups
The list of ARNs for the report groups in the current AWS account.
String reportGroupArn
The ARN of the report group for which you want to return report ARNs.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
String sortOrder
Use to specify whether the results are returned in ascending or descending order.
Integer maxResults
The maximum number of paginated reports in this report group returned per response. Use nextToken to
iterate pages in the list of returned Report objects. The default value is 100.
ReportFilter filter
A ReportFilter object used to filter the returned reports.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
List<E> reports
The list of report ARNs.
String sortOrder
Specifies the sort order for the list of returned reports. Valid values are:
ASCENDING: return reports in chronological order based on their creation date.
DESCENDING: return reports in the reverse chronological order based on their creation date.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
Integer maxResults
The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the
list of returned Report objects. The default value is 100.
ReportFilter filter
A ReportFilter object used to filter the returned reports.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
List<E> reports
The list of returned ARNs for the reports in the current AWS account.
String sortBy
The criterion to be used to list build projects shared with the current AWS account or user. Valid values include:
ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared project was last changed.
String sortOrder
The order in which to list shared build projects. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
Integer maxResults
The maximum number of paginated shared build projects returned per response. Use nextToken to
iterate pages in the list of returned Project objects. The default value is 100.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
List<E> projects
The list of ARNs for the build projects shared with the current AWS account or user.
String sortOrder
The order in which to list shared report groups. Valid values include:
ASCENDING: List in ascending order.
DESCENDING: List in descending order.
String sortBy
The criterion to be used to list report groups shared with the current AWS account or user. Valid values include:
ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared report group was last changed.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
Integer maxResults
The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in
the list of returned ReportGroup objects. The default value is 100.
String nextToken
During a previous call, the maximum number of items that can be returned is the value specified in
maxResults. If there more items in the list, then a unique string called a nextToken is
returned. To get the next batch of items in the list, call this operation again, adding the next token to the
call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
returned, until no more next tokens are returned.
List<E> reportGroups
The list of ARNs for the report groups shared with the current AWS account or user.
CloudWatchLogsConfig cloudWatchLogs
Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default.
S3LogsConfig s3Logs
Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
String groupName
The name of the Amazon CloudWatch Logs group for the build logs.
String streamName
The name of the Amazon CloudWatch Logs stream for the build logs.
String deepLink
The URL to an individual build log in Amazon CloudWatch Logs.
String s3DeepLink
The URL to a build log in an S3 bucket.
String cloudWatchLogsArn
The ARN of Amazon CloudWatch Logs for a build project. Its format is
arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}.
For more information, see Resources Defined by Amazon CloudWatch Logs.
String s3LogsArn
The ARN of S3 logs for a build project. Its format is
arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more information, see Resources Defined by Amazon S3.
CloudWatchLogsConfig cloudWatchLogs
Information about Amazon CloudWatch Logs for a build project.
S3LogsConfig s3Logs
Information about S3 logs for a build project.
String name
The name of the build project.
String arn
The Amazon Resource Name (ARN) of the build project.
String description
A description that makes the build project easy to identify.
ProjectSource source
Information about the build input source code for this build project.
List<E> secondarySources
An array of ProjectSource objects.
String 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 AWS 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 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 AWS CodeBuild User Guide.
List<E> secondarySourceVersions
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at
the build level, then they take over these secondarySourceVersions (at the project level).
ProjectArtifacts artifacts
Information about the build output artifacts for the build project.
List<E> secondaryArtifacts
An array of ProjectArtifacts objects.
ProjectCache cache
Information about the cache for the build project.
ProjectEnvironment environment
Information about the build environment for this build project.
String serviceRole
The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
Integer timeoutInMinutes
How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
Integer queuedTimeoutInMinutes
The number of minutes a build is allowed to be queued before it times out.
String encryptionKey
The AWS Key Management Service (AWS KMS) 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/<alias-name>).
List<E> tags
A list of tag key and value pairs associated with this build project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
Date created
When the build project was created, expressed in Unix time format.
Date lastModified
When the build project's settings were last modified, expressed in Unix time format.
Webhook webhook
Information about a webhook that connects repository events to a build project in AWS CodeBuild.
VpcConfig vpcConfig
Information about the VPC configuration that AWS CodeBuild accesses.
ProjectBadge badge
Information about the build badge for the build project.
LogsConfig logsConfig
Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.
List<E> 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.
ProjectBuildBatchConfig buildBatchConfig
A ProjectBuildBatchConfig object that defines the batch build options for the project.
Integer 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.
String type
The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through AWS CodePipeline.
The CODEPIPELINE type is not supported for secondaryArtifacts.
NO_ARTIFACTS: The build project does not produce any build output.
S3: The build project stores build output in Amazon S3.
String location
Information about the build output artifact location:
If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This
is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build
output is produced.
If type is set to S3, this is the name of the output bucket.
String path
Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and
store the output artifact:
If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This
is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build
output is produced.
If type is set to S3, this is the path to the output artifact. If path is
not specified, path is not used.
For example, if path is set to MyArtifacts, namespaceType is set to
NONE, and name is set to MyArtifact.zip, the output artifact is stored in
the output bucket at MyArtifacts/MyArtifact.zip.
String namespaceType
Along with path and name, the pattern that AWS CodeBuild uses to determine the name and
location to store the output artifact:
If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This
is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build
output is produced.
If type is set to S3, valid values include:
BUILD_ID: Include the build ID in the location of the build output artifact.
NONE: Do not include the build ID. This is the default if namespaceType is not
specified.
For example, if path is set to MyArtifacts, namespaceType is set to
BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored
in MyArtifacts/<build-ID>/MyArtifact.zip.
String name
Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and
store the output artifact:
If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This
is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build
output is produced.
If type is set to S3, 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.
For example:
If path is set to MyArtifacts, namespaceType is set to
BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is
stored in MyArtifacts/<build-ID>/MyArtifact.zip.
If path is empty, namespaceType is set to NONE, and name is
set to "/", the output artifact is stored in the root of the output bucket.
If path is set to MyArtifacts, namespaceType is set to
BUILD_ID, and name is set to "/", the output artifact is stored in
MyArtifacts/<build-ID>.
String packaging
The type of build output artifact to create:
If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This
is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build
output is produced.
If type is set to S3, valid values include:
NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is
the default if packaging is not specified.
ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
Boolean overrideArtifactName
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.
Boolean encryptionDisabled
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.
String artifactIdentifier
An identifier for this artifact definition.
String bucketOwnerAccess
String serviceRole
Specifies the service role ARN for the batch build project.
Boolean combineArtifacts
Specifies if the build artifacts for the batch build should be combined into a single artifact location.
BatchRestrictions restrictions
A BatchRestrictions object that specifies the restrictions for the batch build.
Integer timeoutInMins
Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
String type
The type of cache used by the build project. Valid values include:
NO_CACHE: The build project does not use any cache.
S3: The build project reads and writes from and to S3.
LOCAL: The build project stores a cache locally on a build host that is only available to that build
host.
String location
Information about the cache location:
NO_CACHE or LOCAL: This value is ignored.
S3: This is the S3 bucket name/prefix.
List<E> modes
An array of strings that specify the local cache modes. You can use one or more local cache modes at the same
time. This is only used for LOCAL cache types.
Possible values are:
Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
You can use a Docker layer cache in the Linux environment only.
The privileged flag must be set so that your project has the required Docker permissions.
You should consider the security implications before you use a Docker layer cache.
Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
String type
The type of build environment to use for related builds.
The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East
(Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and
EU (Frankfurt).
The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is
available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU
(Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore),
Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East
(Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia
Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).
String image
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
For an image tag: <registry>/<repository>:<tag>. For example, in the Docker
repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0
.
For an image digest: <registry>/<repository>@<digest>. For example, to specify an
image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use
<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf
.
String computeType
Information about the compute resources the build project uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment
type.
BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds.
This compute type supports Docker images up to 100 GB uncompressed.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA
Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based
processors for builds.
For more information, see Build Environment Compute Types in the AWS CodeBuild User Guide.
List<E> environmentVariables
A set of environment variables to make available to builds for this build project.
Boolean privilegedMode
Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to
build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default
setting is false.
You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"
If the operating system's base image is Alpine Linux and the previous command does not work, add the
-t argument to timeout:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"
String certificate
The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the AWS CodeBuild User Guide.
RegistryCredential registryCredential
The credentials for access to a private registry.
String imagePullCredentialsType
The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your
ECR repository policy to trust AWS CodeBuild's service principal.
SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.
When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
String type
The type of the file system. The one supported type is EFS.
String location
A string that specifies the location of the file system created by Amazon EFS. Its format is
efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the AWS
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 fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory
is my-efs-mount-directory, then the location is
fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.
The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a
directory path, the location is only the DNS name and CodeBuild mounts the entire file system.
String mountPoint
The location in the container where you mount the file system.
String identifier
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by
appending the identifier in all capital letters to CODEBUILD_. For example, if you
specify my_efs for identifier, a new environment variable is create named
CODEBUILD_MY_EFS.
The identifier is used to mount your file system.
String mountOptions
The mount options for a file system created by AWS EFS. The default mount options used by CodeBuild are
nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount
Options.
String type
The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.
CODECOMMIT: The source code is in an AWS CodeCommit repository.
CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS
CodePipeline.
GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud repository.
GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.
NO_SOURCE: The project does not have input source code.
S3: The source code is in an Amazon S3 bucket.
String location
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline in AWS CodePipeline,
location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because
AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source
code and the buildspec file (for example,
https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).
For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example,
<bucket-name>/<path>/<object-name>.zip).
The path to the folder that contains the source code (for example,
<bucket-name>/<path-to-source-code>/<folder>/).
For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the
buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start
creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub
Authorize application page, for Organization access, choose Request access next to each
repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application.
(After you have connected to your GitHub account, you do not need to finish creating the build project. You can
leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source
object, set the auth object's type value to OAUTH.
For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the
buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to
start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the
Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to
your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild
console.) To instruct AWS CodeBuild to use this connection, in the source object, set the
auth object's type value to OAUTH.
Integer gitCloneDepth
Information about the Git clone depth for the build project.
GitSubmodulesConfig gitSubmodulesConfig
Information about the Git submodules configuration for the build project.
String buildspec
The buildspec file declaration to use for the builds in this 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 AWS 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.
SourceAuth auth
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
Boolean reportBuildStatus
Set to true to report the status of a build's start and finish to your source provider. This option is valid only
when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different
source provider, an invalidInputException is thrown.
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 Source provider access in the AWS CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
BuildStatusConfig buildStatusConfig
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 GITHUB, GITHUB_ENTERPRISE, or
BITBUCKET.
Boolean insecureSsl
Enable this flag to ignore SSL warnings while connecting to the project source code.
String sourceIdentifier
An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.
String sourceIdentifier
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.
String sourceVersion
The source version for the corresponding source identifier. If specified, must be one of:
For AWS 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 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.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
String policy
A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the AWS CodeBuild User Guide.
String resourceArn
The ARN of the Project or ReportGroup resource you want to associate with a resource
policy.
String resourceArn
The ARN of the Project or ReportGroup resource that is associated with a resource
policy.
String credential
The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.
The credential can use the name of the credentials only if they exist in your current AWS Region.
String credentialProvider
The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.
String arn
The ARN of the report run.
String type
The type of the report that was run.
A code coverage report.
A test report.
String name
The name of the report that was run.
String reportGroupArn
The ARN of the report group associated with this report.
String executionId
The ARN of the build run that generated this report.
String status
The status of this report.
Date created
The date and time this report run occurred.
Date expired
The date and time a report expires. A report expires 30 days after it is created. An expired report is not available to view in CodeBuild.
ReportExportConfig exportConfig
Information about where the raw data used to generate this report was exported.
Boolean truncated
A boolean that specifies if this report run is truncated. The list of test cases is truncated after the maximum number of test cases is reached.
TestReportSummary testSummary
A TestReportSummary object that contains information about this test report.
CodeCoverageReportSummary codeCoverageSummary
A CodeCoverageReportSummary object that contains a code coverage summary for this report.
String exportConfigType
The export configuration type. Valid values are:
S3: The report results are exported to an S3 bucket.
NO_EXPORT: The report results are not exported.
S3ReportExportConfig s3Destination
A S3ReportExportConfig object that contains information about the S3 bucket where the run of a
report is exported.
String status
The status used to filter reports. You can filter using one status only.
String arn
The ARN of the ReportGroup.
String name
The name of the ReportGroup.
String type
The type of the ReportGroup. This can be one of the following values:
The report group contains code coverage reports.
The report group contains test reports.
ReportExportConfig exportConfig
Information about the destination where the raw data of this ReportGroup is exported.
Date created
The date and time this ReportGroup was created.
Date lastModified
The date and time this ReportGroup was last modified.
List<E> tags
A list of tag key and value pairs associated with this report group.
These tags are available for use by AWS services that support AWS CodeBuild report group tags.
String status
The status of the report group. This property is read-only.
This can be one of the following values:
The report group is active.
The report group is in the process of being deleted.
String id
Specifies the identifier of the batch build to restart.
String idempotencyToken
A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuildBatch
request. The token is included in the RetryBuildBatch request and is valid for five minutes. If you
repeat the RetryBuildBatch request with the same token, but change a parameter, AWS CodeBuild
returns a parameter mismatch error.
String retryType
Specifies the type of retry to perform.
BuildBatch buildBatch
String id
Specifies the identifier of the build to restart.
String idempotencyToken
A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuild request.
The token is included in the RetryBuild request and is valid for five minutes. If you repeat the
RetryBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter
mismatch error.
Build build
String status
The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.
DISABLED: S3 build logs are not enabled for this build project.
String location
The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket,
and your path prefix is build-log, then acceptable formats are my-bucket/build-log or
arn:aws:s3:::my-bucket/build-log.
Boolean encryptionDisabled
Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
String bucketOwnerAccess
String bucket
The name of the S3 bucket where the raw data of a report are exported.
String bucketOwner
The AWS account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.
String path
The path to the exported report's raw data results.
String packaging
The type of build output artifact to create. Valid values include:
NONE: AWS CodeBuild creates the raw data in the output bucket. This is the default if packaging is
not specified.
ZIP: AWS CodeBuild creates a ZIP file with the raw data in the output bucket.
String encryptionKey
The encryption key for the report's encrypted raw data.
Boolean encryptionDisabled
A boolean value that specifies if the results of a report are encrypted.
String arn
The Amazon Resource Name (ARN) of the token.
String serverType
The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
String authType
The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.
String projectName
The name of the project.
List<E> secondarySourcesOverride
An array of ProjectSource objects that override the secondary sources defined in the batch build
project.
List<E> secondarySourcesVersionOverride
An array of ProjectSourceVersion objects that override the secondary source versions in the batch
build project.
String sourceVersion
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:
The commit ID, branch, or Git tag to use.
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.
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.
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the
build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
ProjectArtifacts artifactsOverride
An array of ProjectArtifacts objects that contains information about the build output artifact
overrides for the build project.
List<E> secondaryArtifactsOverride
An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch
build project.
List<E> environmentVariablesOverride
An array of EnvironmentVariable objects that override, or add to, the environment variables defined
in the batch build project.
String sourceTypeOverride
The source input type that overrides the source input defined in the batch build project.
String sourceLocationOverride
A location that overrides, for this batch build, the source location defined in the batch build project.
SourceAuth sourceAuthOverride
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.
Integer gitCloneDepthOverride
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.
GitSubmodulesConfig gitSubmodulesConfigOverride
A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.
String buildspecOverride
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 AWS 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.
Boolean insecureSslOverride
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.
Boolean reportBuildBatchStatusOverride
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, an
invalidInputException is thrown.
The status of a build triggered by a webhook is always reported to your source provider.
String environmentTypeOverride
A container type for this batch build that overrides the one specified in the batch build project.
String imageOverride
The name of an image for this batch build that overrides the one specified in the batch build project.
String computeTypeOverride
The name of a compute type for this batch build that overrides the one specified in the batch build project.
String certificateOverride
The name of a certificate for this batch build that overrides the one specified in the batch build project.
ProjectCache cacheOverride
A ProjectCache object that specifies cache overrides.
String serviceRoleOverride
The name of a service role for this batch build that overrides the one specified in the batch build project.
Boolean privilegedModeOverride
Enable this flag to override privileged mode in the batch build project.
Integer buildTimeoutInMinutesOverride
Overrides the build timeout specified in the batch build project.
Integer queuedTimeoutInMinutesOverride
The number of minutes a batch build is allowed to be queued before it times out.
String encryptionKeyOverride
The AWS Key Management Service (AWS KMS) 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/<alias-name>).
String idempotencyToken
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch
request. The token is included in the StartBuildBatch request and is valid for five minutes. If you
repeat the StartBuildBatch request with the same token, but change a parameter, AWS CodeBuild
returns a parameter mismatch error.
LogsConfig logsConfigOverride
A LogsConfig object that override the log settings defined in the batch build project.
RegistryCredential registryCredentialOverride
A RegistryCredential object that overrides credentials for access to a private registry.
String imagePullCredentialsTypeOverride
The type of credentials AWS CodeBuild uses to pull images in your batch build. There are two valid values:
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS 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 AWS CodeBuild curated image, you must use CODEBUILD credentials.
ProjectBuildBatchConfig buildBatchConfigOverride
A BuildBatchConfigOverride object that contains batch build configuration overrides.
Boolean debugSessionEnabled
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.
BuildBatch buildBatch
A BuildBatch object that contains information about the batch build.
String projectName
The name of the AWS CodeBuild build project to start running a build.
List<E> secondarySourcesOverride
An array of ProjectSource objects.
List<E> secondarySourcesVersionOverride
An array of ProjectSourceVersion objects that specify one or more versions of the project's
secondary sources to be used for this build only.
String sourceVersion
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:
The commit ID, branch, or Git tag to use.
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.
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.
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the project level, then this sourceVersion (at the
build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.
ProjectArtifacts artifactsOverride
Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
List<E> secondaryArtifactsOverride
An array of ProjectArtifacts objects.
List<E> environmentVariablesOverride
A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
String sourceTypeOverride
A source input type, for this build, that overrides the source input defined in the build project.
String sourceLocationOverride
A location that overrides, for this build, the source location for the one defined in the build project.
SourceAuth sourceAuthOverride
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.
Integer gitCloneDepthOverride
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.
GitSubmodulesConfig gitSubmodulesConfigOverride
Information about the Git submodules configuration for this build of an AWS CodeBuild build project.
String buildspecOverride
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 AWS 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.
Boolean insecureSslOverride
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.
Boolean reportBuildStatusOverride
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
invalidInputException is thrown.
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 Source provider access in the AWS CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
BuildStatusConfig buildStatusConfigOverride
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 GITHUB, GITHUB_ENTERPRISE, or
BITBUCKET.
String environmentTypeOverride
A container type for this build that overrides the one specified in the build project.
String imageOverride
The name of an image for this build that overrides the one specified in the build project.
String computeTypeOverride
The name of a compute type for this build that overrides the one specified in the build project.
String certificateOverride
The name of a certificate for this build that overrides the one specified in the build project.
ProjectCache cacheOverride
A ProjectCache object specified for this build that overrides the one defined in the build project.
String serviceRoleOverride
The name of a service role for this build that overrides the one specified in the build project.
Boolean privilegedModeOverride
Enable this flag to override privileged mode in the build project.
Integer timeoutInMinutesOverride
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.
Integer queuedTimeoutInMinutesOverride
The number of minutes a build is allowed to be queued before it times out.
String encryptionKeyOverride
The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the 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/<alias-name>).
String idempotencyToken
A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
LogsConfig logsConfigOverride
Log settings for this build that override the log settings defined in the build project.
RegistryCredential registryCredentialOverride
The credentials for access to a private registry.
String imagePullCredentialsTypeOverride
The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
Specifies that AWS 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 AWS CodeBuild curated image, you must use CODEBUILD credentials.
Boolean debugSessionEnabled
Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
Build build
Information about the build to be run.
String id
The identifier of the batch build to stop.
BuildBatch buildBatch
String id
The ID of the build.
Build build
Information about the build.
String reportArn
The ARN of the report to which the test case belongs.
String testRawDataPath
The path to the raw data file that contains the test result.
String prefix
A string that is applied to a series of related test cases. CodeBuild generates the prefix. The prefix depends on the framework used to generate the tests.
String name
The name of the test case.
String status
The status returned by the test case after it was run. Valid statuses are SUCCEEDED,
FAILED, ERROR, SKIPPED, and UNKNOWN.
Long durationInNanoSeconds
The number of nanoseconds it took to run this test case.
String message
A message associated with a test case. For example, an error message or stack trace.
Date expired
The date and time a test case expires. A test case expires 30 days after it is created. An expired test case is not available to view in CodeBuild.
String status
The status used to filter test cases. A TestCaseFilter can have one status. Valid values are:
SUCCEEDED
FAILED
ERROR
SKIPPED
UNKNOWN
String keyword
A keyword that is used to filter on the name or the prefix of the test cases. Only test
cases where the keyword is a substring of the name or the prefix will be returned.
Integer total
The number of test cases in this TestReportSummary. The total includes truncated test cases.
Map<K,V> statusCounts
A map that contains the number of each type of status returned by the test results in this
TestReportSummary.
Long durationInNanoSeconds
The number of nanoseconds it took to run all of the test cases in this report.
String name
The name of the build project.
You cannot change a build project's name.
String description
A new or replacement description of the build project.
ProjectSource source
Information to be changed about the build input source code for the build project.
List<E> secondarySources
An array of ProjectSource objects.
String 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 AWS 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 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 AWS CodeBuild User Guide.
List<E> secondarySourceVersions
An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at
the build level, then they take over these secondarySourceVersions (at the project level).
ProjectArtifacts artifacts
Information to be changed about the build output artifacts for the build project.
List<E> secondaryArtifacts
An array of ProjectSource objects.
ProjectCache cache
Stores recently used information so that it can be quickly accessed at a later time.
ProjectEnvironment environment
Information to be changed about the build environment for the build project.
String serviceRole
The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
Integer timeoutInMinutes
The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.
Integer queuedTimeoutInMinutes
The number of minutes a build is allowed to be queued before it times out.
String encryptionKey
The AWS Key Management Service (AWS KMS) 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/<alias-name>).
List<E> tags
An updated list of tag key and value pairs associated with this build project.
These tags are available for use by AWS services that support AWS CodeBuild build project tags.
VpcConfig vpcConfig
VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
Boolean badgeEnabled
Set this to true to generate a publicly accessible URL for your project's build badge.
LogsConfig logsConfig
Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, logs in an S3 bucket, or both.
List<E> 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.
ProjectBuildBatchConfig buildBatchConfig
Integer 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.
To remove this limit, set this value to -1.
Project project
Information about the build project that was changed.
String arn
The ARN of the report group to update.
ReportExportConfig exportConfig
Used to specify an updated export type. Valid values are:
S3: The report results are exported to an S3 bucket.
NO_EXPORT: The report results are not exported.
List<E> tags
An updated list of tag key and value pairs associated with this report group.
These tags are available for use by AWS services that support AWS CodeBuild report group tags.
ReportGroup reportGroup
Information about the updated report group.
String projectName
The name of the AWS CodeBuild project.
String branchFilter
A regular expression used to determine which repository branches are built when a webhook is triggered. If the
name of a branch matches the regular expression, then it is built. If branchFilter is empty, then
all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
Boolean rotateSecret
A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you
use Bitbucket for your repository, rotateSecret is ignored.
List<E> filterGroups
An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a
build. A filter group must contain at least one EVENT WebhookFilter.
String buildType
Specifies the type of build this webhook will trigger.
Webhook webhook
Information about a repository's webhook that is associated with a project in AWS CodeBuild.
String url
The URL to the webhook.
String payloadUrl
The AWS CodeBuild endpoint where webhook events are sent.
String secret
The secret token of the associated repository.
A Bitbucket webhook does not support secret.
String branchFilter
A regular expression used to determine which repository branches are built when a webhook is triggered. If the
name of a branch matches the regular expression, then it is built. If branchFilter is empty, then
all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
List<E> filterGroups
An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least
one WebhookFilter in the array must specify EVENT as its type.
For a build to be triggered, at least one filter group in the filterGroups array must pass. For a
filter group to pass, each of its filters must pass.
String buildType
Specifies the type of build this webhook will trigger.
Date lastModifiedSecret
A timestamp that indicates the last time a repository's secret token was modified.
String type
The type of webhook filter. There are six webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, and COMMIT_MESSAGE.
A webhook event triggers a build when the provided pattern matches one of five event types:
PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED,
PULL_REQUEST_REOPENED, and PULL_REQUEST_MERGED. The EVENT patterns are
specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED
filters all push, pull request created, and pull request updated events.
The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only.
A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular
expression pattern.
A webhook event triggers a build when the head reference matches the regular expression pattern. For
example, refs/heads/branch-name and refs/tags/tag-name.
Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
A webhook event triggers a build when the base reference matches the regular expression pattern. For
example, refs/heads/branch-name.
Works with pull request events only.
A webhook triggers a build when the path of a changed file matches the regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
A webhook triggers a build when the head commit message matches the regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
String pattern
For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one
or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED
allows all push, pull request created, and pull request updated events to trigger a build.
For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For
example, a WebHookFilter that uses HEAD_REF for its type and the pattern
^refs/heads/ triggers a build when the head reference is a branch with a reference name
refs/heads/branch-name.
Boolean excludeMatchedPattern
Used to indicate that the pattern determines which webhook events do not trigger a build. If true,
then a webhook event that does not match the pattern triggers a build. If false, then a webhook
event that matches the pattern triggers a build.
Copyright © 2021. All rights reserved.