Amazonka.CodeBuild.Lens

Operations

BatchDeleteBuilds

batchDeleteBuilds_ids :: Lens' BatchDeleteBuilds (NonEmpty Text)

The IDs of the builds to delete.

batchDeleteBuildsResponse_buildsDeleted :: Lens' BatchDeleteBuildsResponse (Maybe (NonEmpty Text))

The IDs of the builds that were successfully deleted.

batchDeleteBuildsResponse_buildsNotDeleted :: Lens' BatchDeleteBuildsResponse (Maybe [BuildNotDeleted])

Information about any builds that could not be successfully deleted.

batchDeleteBuildsResponse_httpStatus :: Lens' BatchDeleteBuildsResponse Int

The response's http status code.

BatchGetBuildBatches

batchGetBuildBatches_ids :: Lens' BatchGetBuildBatches [Text]

An array that contains the batch build identifiers to retrieve.

batchGetBuildBatchesResponse_buildBatches :: Lens' BatchGetBuildBatchesResponse (Maybe [BuildBatch])

An array of BuildBatch objects that represent the retrieved batch builds.

batchGetBuildBatchesResponse_buildBatchesNotFound :: Lens' BatchGetBuildBatchesResponse (Maybe [Text])

An array that contains the identifiers of any batch builds that are not found.

batchGetBuildBatchesResponse_httpStatus :: Lens' BatchGetBuildBatchesResponse Int

The response's http status code.

BatchGetBuilds

batchGetBuilds_ids :: Lens' BatchGetBuilds (NonEmpty Text)

The IDs of the builds.

batchGetBuildsResponse_builds :: Lens' BatchGetBuildsResponse (Maybe [Build])

Information about the requested builds.

batchGetBuildsResponse_buildsNotFound :: Lens' BatchGetBuildsResponse (Maybe (NonEmpty Text))

The IDs of builds for which information could not be found.

batchGetBuildsResponse_httpStatus :: Lens' BatchGetBuildsResponse Int

The response's http status code.

BatchGetProjects

batchGetProjects_names :: Lens' BatchGetProjects (NonEmpty Text)

The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project using its name.

batchGetProjectsResponse_projects :: Lens' BatchGetProjectsResponse (Maybe [Project])

Information about the requested build projects.

batchGetProjectsResponse_projectsNotFound :: Lens' BatchGetProjectsResponse (Maybe (NonEmpty Text))

The names of build projects for which information could not be found.

batchGetProjectsResponse_httpStatus :: Lens' BatchGetProjectsResponse Int

The response's http status code.

BatchGetReportGroups

batchGetReportGroups_reportGroupArns :: Lens' BatchGetReportGroups (NonEmpty Text)

An array of report group ARNs that identify the report groups to return.

batchGetReportGroupsResponse_reportGroups :: Lens' BatchGetReportGroupsResponse (Maybe (NonEmpty ReportGroup))

The array of report groups returned by BatchGetReportGroups.

batchGetReportGroupsResponse_reportGroupsNotFound :: Lens' BatchGetReportGroupsResponse (Maybe (NonEmpty Text))

An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup.

batchGetReportGroupsResponse_httpStatus :: Lens' BatchGetReportGroupsResponse Int

The response's http status code.

BatchGetReports

batchGetReports_reportArns :: Lens' BatchGetReports (NonEmpty Text)

An array of ARNs that identify the Report objects to return.

batchGetReportsResponse_reports :: Lens' BatchGetReportsResponse (Maybe (NonEmpty Report))

The array of Report objects returned by BatchGetReports.

batchGetReportsResponse_reportsNotFound :: Lens' BatchGetReportsResponse (Maybe (NonEmpty Text))

An array of ARNs passed to BatchGetReportGroups that are not associated with a Report.

batchGetReportsResponse_httpStatus :: Lens' BatchGetReportsResponse Int

The response's http status code.

CreateProject

createProject_badgeEnabled :: Lens' CreateProject (Maybe Bool)

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

createProject_buildBatchConfig :: Lens' CreateProject (Maybe ProjectBuildBatchConfig)

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

createProject_cache :: Lens' CreateProject (Maybe ProjectCache)

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

createProject_concurrentBuildLimit :: Lens' CreateProject (Maybe Int)

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.

createProject_description :: Lens' CreateProject (Maybe Text)

A description that makes the build project easy to identify.

createProject_encryptionKey :: Lens' CreateProject (Maybe Text)

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

createProject_fileSystemLocations :: Lens' CreateProject (Maybe [ProjectFileSystemLocation])

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.

createProject_logsConfig :: Lens' CreateProject (Maybe LogsConfig)

Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.

createProject_queuedTimeoutInMinutes :: Lens' CreateProject (Maybe Natural)

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

createProject_secondaryArtifacts :: Lens' CreateProject (Maybe [ProjectArtifacts])

An array of ProjectArtifacts objects.

createProject_secondarySourceVersions :: Lens' CreateProject (Maybe [ProjectSourceVersion])

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

createProject_secondarySources :: Lens' CreateProject (Maybe [ProjectSource])

An array of ProjectSource objects.

createProject_sourceVersion :: Lens' CreateProject (Maybe Text)

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

• For CodeCommit: the commit ID, branch, or Git tag to use.
• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

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

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

createProject_tags :: Lens' CreateProject (Maybe [Tag])

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

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

createProject_timeoutInMinutes :: Lens' CreateProject (Maybe Natural)

How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.

createProject_vpcConfig :: Lens' CreateProject (Maybe VpcConfig)

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

createProject_name :: Lens' CreateProject Text

The name of the build project.

createProject_source :: Lens' CreateProject ProjectSource

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

createProject_artifacts :: Lens' CreateProject ProjectArtifacts

Information about the build output artifacts for the build project.

createProject_environment :: Lens' CreateProject ProjectEnvironment

Information about the build environment for the build project.

createProject_serviceRole :: Lens' CreateProject Text

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

createProjectResponse_project :: Lens' CreateProjectResponse (Maybe Project)

Information about the build project that was created.

createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int

The response's http status code.

CreateReportGroup

createReportGroup_tags :: Lens' CreateReportGroup (Maybe [Tag])

A list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

createReportGroup_name :: Lens' CreateReportGroup Text

The name of the report group.

createReportGroup_type :: Lens' CreateReportGroup ReportType

The type of report group.

createReportGroup_exportConfig :: Lens' CreateReportGroup ReportExportConfig

A ReportExportConfig object that contains information about where the report group test results are exported.

createReportGroupResponse_reportGroup :: Lens' CreateReportGroupResponse (Maybe ReportGroup)

Information about the report group that was created.

createReportGroupResponse_httpStatus :: Lens' CreateReportGroupResponse Int

The response's http status code.

CreateWebhook

createWebhook_branchFilter :: Lens' CreateWebhook (Maybe Text)

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.

createWebhook_buildType :: Lens' CreateWebhook (Maybe WebhookBuildType)

Specifies the type of build this webhook will trigger.

createWebhook_filterGroups :: Lens' CreateWebhook (Maybe [[WebhookFilter]])

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.

createWebhook_projectName :: Lens' CreateWebhook Text

The name of the CodeBuild project.

createWebhookResponse_webhook :: Lens' CreateWebhookResponse (Maybe Webhook)

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

createWebhookResponse_httpStatus :: Lens' CreateWebhookResponse Int

The response's http status code.

DeleteBuildBatch

deleteBuildBatch_id :: Lens' DeleteBuildBatch Text

The identifier of the batch build to delete.

deleteBuildBatchResponse_buildsDeleted :: Lens' DeleteBuildBatchResponse (Maybe (NonEmpty Text))

An array of strings that contain the identifiers of the builds that were deleted.

deleteBuildBatchResponse_buildsNotDeleted :: Lens' DeleteBuildBatchResponse (Maybe [BuildNotDeleted])

An array of BuildNotDeleted objects that specify the builds that could not be deleted.

deleteBuildBatchResponse_statusCode :: Lens' DeleteBuildBatchResponse (Maybe Text)

The status code.

deleteBuildBatchResponse_httpStatus :: Lens' DeleteBuildBatchResponse Int

The response's http status code.

DeleteProject

deleteProject_name :: Lens' DeleteProject Text

The name of the build project.

deleteProjectResponse_httpStatus :: Lens' DeleteProjectResponse Int

The response's http status code.

DeleteReport

deleteReport_arn :: Lens' DeleteReport Text

The ARN of the report to delete.

deleteReportResponse_httpStatus :: Lens' DeleteReportResponse Int

The response's http status code.

DeleteReportGroup

deleteReportGroup_deleteReports :: Lens' DeleteReportGroup (Maybe Bool)

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.

deleteReportGroup_arn :: Lens' DeleteReportGroup Text

The ARN of the report group to delete.

deleteReportGroupResponse_httpStatus :: Lens' DeleteReportGroupResponse Int

The response's http status code.

DeleteResourcePolicy

deleteResourcePolicy_resourceArn :: Lens' DeleteResourcePolicy Text

The ARN of the resource that is associated with the resource policy.

deleteResourcePolicyResponse_httpStatus :: Lens' DeleteResourcePolicyResponse Int

The response's http status code.

DeleteSourceCredentials

deleteSourceCredentials_arn :: Lens' DeleteSourceCredentials Text

The Amazon Resource Name (ARN) of the token.

deleteSourceCredentialsResponse_arn :: Lens' DeleteSourceCredentialsResponse (Maybe Text)

The Amazon Resource Name (ARN) of the token.

deleteSourceCredentialsResponse_httpStatus :: Lens' DeleteSourceCredentialsResponse Int

The response's http status code.

DeleteWebhook

deleteWebhook_projectName :: Lens' DeleteWebhook Text

The name of the CodeBuild project.

deleteWebhookResponse_httpStatus :: Lens' DeleteWebhookResponse Int

The response's http status code.

DescribeCodeCoverages

describeCodeCoverages_maxLineCoveragePercentage :: Lens' DescribeCodeCoverages (Maybe Double)

The maximum line coverage percentage to report.

describeCodeCoverages_maxResults :: Lens' DescribeCodeCoverages (Maybe Natural)

The maximum number of results to return.

describeCodeCoverages_minLineCoveragePercentage :: Lens' DescribeCodeCoverages (Maybe Double)

The minimum line coverage percentage to report.

describeCodeCoverages_nextToken :: Lens' DescribeCodeCoverages (Maybe Text)

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.

describeCodeCoverages_sortBy :: Lens' DescribeCodeCoverages (Maybe ReportCodeCoverageSortByType)

Specifies how the results are sorted. Possible values are:

FILE_PATH

The results are sorted by file path.

LINE_COVERAGE_PERCENTAGE

The results are sorted by the percentage of lines that are covered.

describeCodeCoverages_sortOrder :: Lens' DescribeCodeCoverages (Maybe SortOrderType)

Specifies if the results are sorted in ascending or descending order.

describeCodeCoverages_reportArn :: Lens' DescribeCodeCoverages Text

The ARN of the report for which test cases are returned.

describeCodeCoveragesResponse_codeCoverages :: Lens' DescribeCodeCoveragesResponse (Maybe [CodeCoverage])

An array of CodeCoverage objects that contain the results.

describeCodeCoveragesResponse_nextToken :: Lens' DescribeCodeCoveragesResponse (Maybe Text)

If there are more items to return, this contains a token that is passed to a subsequent call to DescribeCodeCoverages to retrieve the next set of items.

describeCodeCoveragesResponse_httpStatus :: Lens' DescribeCodeCoveragesResponse Int

The response's http status code.

DescribeTestCases

describeTestCases_filter :: Lens' DescribeTestCases (Maybe TestCaseFilter)

A TestCaseFilter object used to filter the returned reports.

describeTestCases_maxResults :: Lens' DescribeTestCases (Maybe Natural)

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.

describeTestCases_nextToken :: Lens' DescribeTestCases (Maybe Text)

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.

describeTestCases_reportArn :: Lens' DescribeTestCases Text

The ARN of the report for which test cases are returned.

describeTestCasesResponse_nextToken :: Lens' DescribeTestCasesResponse (Maybe Text)

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.

describeTestCasesResponse_testCases :: Lens' DescribeTestCasesResponse (Maybe [TestCase])

The returned list of test cases.

describeTestCasesResponse_httpStatus :: Lens' DescribeTestCasesResponse Int

The response's http status code.

GetReportGroupTrend

getReportGroupTrend_numOfReports :: Lens' GetReportGroupTrend (Maybe Natural)

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.

getReportGroupTrend_reportGroupArn :: Lens' GetReportGroupTrend Text

The ARN of the report group that contains the reports to analyze.

getReportGroupTrend_trendField :: Lens' GetReportGroupTrend ReportGroupTrendFieldType

The test report value to accumulate. This must be one of the following values:

Test reports:

DURATION

Accumulate the test run times for the specified reports.

PASS_RATE

Accumulate the percentage of tests that passed for the specified test reports.

TOTAL

Accumulate the total number of tests for the specified test reports.

Code coverage reports:

BRANCH_COVERAGE

Accumulate the branch coverage percentages for the specified test reports.

BRANCHES_COVERED

Accumulate the branches covered values for the specified test reports.

BRANCHES_MISSED

Accumulate the branches missed values for the specified test reports.

LINE_COVERAGE

Accumulate the line coverage percentages for the specified test reports.

LINES_COVERED

Accumulate the lines covered values for the specified test reports.

LINES_MISSED

Accumulate the lines not covered values for the specified test reports.

getReportGroupTrendResponse_rawData :: Lens' GetReportGroupTrendResponse (Maybe [ReportWithRawData])

An array that contains the raw data for each report.

getReportGroupTrendResponse_stats :: Lens' GetReportGroupTrendResponse (Maybe ReportGroupTrendStats)

Contains the accumulated trend data.

getReportGroupTrendResponse_httpStatus :: Lens' GetReportGroupTrendResponse Int

The response's http status code.

GetResourcePolicy

getResourcePolicy_resourceArn :: Lens' GetResourcePolicy Text

The ARN of the resource that is associated with the resource policy.

getResourcePolicyResponse_policy :: Lens' GetResourcePolicyResponse (Maybe Text)

The resource policy for the resource identified by the input ARN parameter.

getResourcePolicyResponse_httpStatus :: Lens' GetResourcePolicyResponse Int

The response's http status code.

ImportSourceCredentials

importSourceCredentials_shouldOverwrite :: Lens' ImportSourceCredentials (Maybe Bool)

Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.

importSourceCredentials_username :: Lens' ImportSourceCredentials (Maybe Text)

The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

importSourceCredentials_token :: Lens' ImportSourceCredentials Text

For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.

importSourceCredentials_serverType :: Lens' ImportSourceCredentials ServerType

The source provider used for this project.

importSourceCredentials_authType :: Lens' ImportSourceCredentials 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 CodeBuild console.

importSourceCredentialsResponse_arn :: Lens' ImportSourceCredentialsResponse (Maybe Text)

The Amazon Resource Name (ARN) of the token.

importSourceCredentialsResponse_httpStatus :: Lens' ImportSourceCredentialsResponse Int

The response's http status code.

InvalidateProjectCache

invalidateProjectCache_projectName :: Lens' InvalidateProjectCache Text

The name of the CodeBuild build project that the cache is reset for.

invalidateProjectCacheResponse_httpStatus :: Lens' InvalidateProjectCacheResponse Int

The response's http status code.

ListBuildBatches

listBuildBatches_filter :: Lens' ListBuildBatches (Maybe BuildBatchFilter)

A BuildBatchFilter object that specifies the filters for the search.

listBuildBatches_maxResults :: Lens' ListBuildBatches (Maybe Natural)

The maximum number of results to return.

listBuildBatches_nextToken :: Lens' ListBuildBatches (Maybe Text)

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.

listBuildBatches_sortOrder :: Lens' ListBuildBatches (Maybe SortOrderType)

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.

listBuildBatchesResponse_ids :: Lens' ListBuildBatchesResponse (Maybe [Text])

An array of strings that contains the batch build identifiers.

listBuildBatchesResponse_nextToken :: Lens' ListBuildBatchesResponse (Maybe Text)

If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatches to retrieve the next set of items.

listBuildBatchesResponse_httpStatus :: Lens' ListBuildBatchesResponse Int

The response's http status code.

ListBuildBatchesForProject

listBuildBatchesForProject_filter :: Lens' ListBuildBatchesForProject (Maybe BuildBatchFilter)

A BuildBatchFilter object that specifies the filters for the search.

listBuildBatchesForProject_maxResults :: Lens' ListBuildBatchesForProject (Maybe Natural)

The maximum number of results to return.

listBuildBatchesForProject_nextToken :: Lens' ListBuildBatchesForProject (Maybe Text)

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.

listBuildBatchesForProject_projectName :: Lens' ListBuildBatchesForProject (Maybe Text)

The name of the project.

listBuildBatchesForProject_sortOrder :: Lens' ListBuildBatchesForProject (Maybe SortOrderType)

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.

listBuildBatchesForProjectResponse_ids :: Lens' ListBuildBatchesForProjectResponse (Maybe [Text])

An array of strings that contains the batch build identifiers.

listBuildBatchesForProjectResponse_nextToken :: Lens' ListBuildBatchesForProjectResponse (Maybe Text)

If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatchesForProject to retrieve the next set of items.

listBuildBatchesForProjectResponse_httpStatus :: Lens' ListBuildBatchesForProjectResponse Int

The response's http status code.

ListBuilds

listBuilds_nextToken :: Lens' ListBuilds (Maybe Text)

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.

listBuilds_sortOrder :: Lens' ListBuilds (Maybe SortOrderType)

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.

listBuildsResponse_ids :: Lens' ListBuildsResponse (Maybe (NonEmpty Text))

A list of build IDs, with each build ID representing a single build.

listBuildsResponse_nextToken :: Lens' ListBuildsResponse (Maybe Text)

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.

listBuildsResponse_httpStatus :: Lens' ListBuildsResponse Int

The response's http status code.

ListBuildsForProject

listBuildsForProject_nextToken :: Lens' ListBuildsForProject (Maybe Text)

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.

listBuildsForProject_sortOrder :: Lens' ListBuildsForProject (Maybe SortOrderType)

The order to sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order.

Valid values include:

• ASCENDING: List the build identifiers in ascending order, by build number.
• DESCENDING: List the build identifiers in descending order, by build number.

If the project has more than 100 builds, setting the sort order will result in an error.

listBuildsForProject_projectName :: Lens' ListBuildsForProject Text

The name of the CodeBuild project.

listBuildsForProjectResponse_ids :: Lens' ListBuildsForProjectResponse (Maybe (NonEmpty Text))

A list of build identifiers for the specified build project, with each build ID representing a single build.

listBuildsForProjectResponse_nextToken :: Lens' ListBuildsForProjectResponse (Maybe Text)

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.

listBuildsForProjectResponse_httpStatus :: Lens' ListBuildsForProjectResponse Int

The response's http status code.

ListCuratedEnvironmentImages

listCuratedEnvironmentImagesResponse_platforms :: Lens' ListCuratedEnvironmentImagesResponse (Maybe [EnvironmentPlatform])

Information about supported platforms for Docker images that are managed by CodeBuild.

listCuratedEnvironmentImagesResponse_httpStatus :: Lens' ListCuratedEnvironmentImagesResponse Int

The response's http status code.

ListProjects

listProjects_nextToken :: Lens' ListProjects (Maybe Text)

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.

listProjects_sortBy :: Lens' ListProjects (Maybe ProjectSortByType)

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.

listProjects_sortOrder :: Lens' ListProjects (Maybe SortOrderType)

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.

listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text)

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.

listProjectsResponse_projects :: Lens' ListProjectsResponse (Maybe (NonEmpty Text))

The list of build project names, with each build project name representing a single build project.

listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int

The response's http status code.

ListReportGroups

listReportGroups_maxResults :: Lens' ListReportGroups (Maybe Natural)

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.

listReportGroups_nextToken :: Lens' ListReportGroups (Maybe Text)

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.

listReportGroups_sortBy :: Lens' ListReportGroups (Maybe ReportGroupSortByType)

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.

listReportGroups_sortOrder :: Lens' ListReportGroups (Maybe SortOrderType)

Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

listReportGroupsResponse_nextToken :: Lens' ListReportGroupsResponse (Maybe Text)

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.

listReportGroupsResponse_reportGroups :: Lens' ListReportGroupsResponse (Maybe (NonEmpty Text))

The list of ARNs for the report groups in the current Amazon Web Services account.

listReportGroupsResponse_httpStatus :: Lens' ListReportGroupsResponse Int

The response's http status code.

ListReports

listReports_filter :: Lens' ListReports (Maybe ReportFilter)

A ReportFilter object used to filter the returned reports.

listReports_maxResults :: Lens' ListReports (Maybe Natural)

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.

listReports_nextToken :: Lens' ListReports (Maybe Text)

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.

listReports_sortOrder :: Lens' ListReports (Maybe SortOrderType)

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.

listReportsResponse_nextToken :: Lens' ListReportsResponse (Maybe Text)

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.

listReportsResponse_reports :: Lens' ListReportsResponse (Maybe (NonEmpty Text))

The list of returned ARNs for the reports in the current Amazon Web Services account.

listReportsResponse_httpStatus :: Lens' ListReportsResponse Int

The response's http status code.

ListReportsForReportGroup

listReportsForReportGroup_filter :: Lens' ListReportsForReportGroup (Maybe ReportFilter)

A ReportFilter object used to filter the returned reports.

listReportsForReportGroup_maxResults :: Lens' ListReportsForReportGroup (Maybe Natural)

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.

listReportsForReportGroup_nextToken :: Lens' ListReportsForReportGroup (Maybe Text)

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.

listReportsForReportGroup_sortOrder :: Lens' ListReportsForReportGroup (Maybe SortOrderType)

Use to specify whether the results are returned in ascending or descending order.

listReportsForReportGroup_reportGroupArn :: Lens' ListReportsForReportGroup Text

The ARN of the report group for which you want to return report ARNs.

listReportsForReportGroupResponse_nextToken :: Lens' ListReportsForReportGroupResponse (Maybe Text)

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.

listReportsForReportGroupResponse_reports :: Lens' ListReportsForReportGroupResponse (Maybe (NonEmpty Text))

The list of report ARNs.

listReportsForReportGroupResponse_httpStatus :: Lens' ListReportsForReportGroupResponse Int

The response's http status code.

ListSharedProjects

listSharedProjects_maxResults :: Lens' ListSharedProjects (Maybe Natural)

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.

listSharedProjects_nextToken :: Lens' ListSharedProjects (Maybe Text)

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.

listSharedProjects_sortBy :: Lens' ListSharedProjects (Maybe SharedResourceSortByType)

The criterion to be used to list build projects shared with the current Amazon Web Services 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.

listSharedProjects_sortOrder :: Lens' ListSharedProjects (Maybe SortOrderType)

The order in which to list shared build projects. Valid values include:

• ASCENDING: List in ascending order.
• DESCENDING: List in descending order.

listSharedProjectsResponse_nextToken :: Lens' ListSharedProjectsResponse (Maybe Text)

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.

listSharedProjectsResponse_projects :: Lens' ListSharedProjectsResponse (Maybe (NonEmpty Text))

The list of ARNs for the build projects shared with the current Amazon Web Services account or user.

listSharedProjectsResponse_httpStatus :: Lens' ListSharedProjectsResponse Int

The response's http status code.

ListSharedReportGroups

listSharedReportGroups_maxResults :: Lens' ListSharedReportGroups (Maybe Natural)

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.

listSharedReportGroups_nextToken :: Lens' ListSharedReportGroups (Maybe Text)

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.

listSharedReportGroups_sortBy :: Lens' ListSharedReportGroups (Maybe SharedResourceSortByType)

The criterion to be used to list report groups shared with the current Amazon Web Services 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.

listSharedReportGroups_sortOrder :: Lens' ListSharedReportGroups (Maybe SortOrderType)

The order in which to list shared report groups. Valid values include:

• ASCENDING: List in ascending order.
• DESCENDING: List in descending order.

listSharedReportGroupsResponse_nextToken :: Lens' ListSharedReportGroupsResponse (Maybe Text)

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.

listSharedReportGroupsResponse_reportGroups :: Lens' ListSharedReportGroupsResponse (Maybe (NonEmpty Text))

The list of ARNs for the report groups shared with the current Amazon Web Services account or user.

listSharedReportGroupsResponse_httpStatus :: Lens' ListSharedReportGroupsResponse Int

The response's http status code.

ListSourceCredentials

listSourceCredentialsResponse_sourceCredentialsInfos :: Lens' ListSourceCredentialsResponse (Maybe [SourceCredentialsInfo])

A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.

listSourceCredentialsResponse_httpStatus :: Lens' ListSourceCredentialsResponse Int

The response's http status code.

PutResourcePolicy

putResourcePolicy_policy :: Lens' PutResourcePolicy Text

A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the CodeBuild User Guide.

putResourcePolicy_resourceArn :: Lens' PutResourcePolicy Text

The ARN of the Project or ReportGroup resource you want to associate with a resource policy.

putResourcePolicyResponse_resourceArn :: Lens' PutResourcePolicyResponse (Maybe Text)

The ARN of the Project or ReportGroup resource that is associated with a resource policy.

putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int

The response's http status code.

RetryBuild

retryBuild_id :: Lens' RetryBuild (Maybe Text)

Specifies the identifier of the build to restart.

retryBuild_idempotencyToken :: Lens' RetryBuild (Maybe Text)

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, CodeBuild returns a parameter mismatch error.

retryBuildResponse_build :: Lens' RetryBuildResponse (Maybe Build)

Undocumented member.

retryBuildResponse_httpStatus :: Lens' RetryBuildResponse Int

The response's http status code.

RetryBuildBatch

retryBuildBatch_id :: Lens' RetryBuildBatch (Maybe Text)

Specifies the identifier of the batch build to restart.

retryBuildBatch_idempotencyToken :: Lens' RetryBuildBatch (Maybe Text)

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, CodeBuild returns a parameter mismatch error.

retryBuildBatch_retryType :: Lens' RetryBuildBatch (Maybe RetryBuildBatchType)

Specifies the type of retry to perform.

retryBuildBatchResponse_buildBatch :: Lens' RetryBuildBatchResponse (Maybe BuildBatch)

Undocumented member.

retryBuildBatchResponse_httpStatus :: Lens' RetryBuildBatchResponse Int

The response's http status code.

StartBuild

startBuild_artifactsOverride :: Lens' StartBuild (Maybe ProjectArtifacts)

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

startBuild_buildStatusConfigOverride :: Lens' StartBuild (Maybe 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.

startBuild_buildspecOverride :: Lens' StartBuild (Maybe Text)

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

startBuild_cacheOverride :: Lens' StartBuild (Maybe ProjectCache)

A ProjectCache object specified for this build that overrides the one defined in the build project.

startBuild_certificateOverride :: Lens' StartBuild (Maybe Text)

The name of a certificate for this build that overrides the one specified in the build project.

startBuild_computeTypeOverride :: Lens' StartBuild (Maybe ComputeType)

The name of a compute type for this build that overrides the one specified in the build project.

startBuild_debugSessionEnabled :: Lens' StartBuild (Maybe Bool)

Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

startBuild_encryptionKeyOverride :: Lens' StartBuild (Maybe Text)

The Key Management Service 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>).

startBuild_environmentTypeOverride :: Lens' StartBuild (Maybe EnvironmentType)

A container type for this build that overrides the one specified in the build project.

startBuild_environmentVariablesOverride :: Lens' StartBuild (Maybe [EnvironmentVariable])

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

startBuild_gitCloneDepthOverride :: Lens' StartBuild (Maybe Natural)

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.

startBuild_gitSubmodulesConfigOverride :: Lens' StartBuild (Maybe GitSubmodulesConfig)

Information about the Git submodules configuration for this build of an CodeBuild build project.

startBuild_idempotencyToken :: Lens' StartBuild (Maybe Text)

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, CodeBuild returns a parameter mismatch error.

startBuild_imageOverride :: Lens' StartBuild (Maybe Text)

The name of an image for this build that overrides the one specified in the build project.

startBuild_imagePullCredentialsTypeOverride :: Lens' StartBuild (Maybe ImagePullCredentialsType)

The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

startBuild_insecureSslOverride :: Lens' StartBuild (Maybe Bool)

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.

startBuild_logsConfigOverride :: Lens' StartBuild (Maybe LogsConfig)

Log settings for this build that override the log settings defined in the build project.

startBuild_privilegedModeOverride :: Lens' StartBuild (Maybe Bool)

Enable this flag to override privileged mode in the build project.

startBuild_queuedTimeoutInMinutesOverride :: Lens' StartBuild (Maybe Natural)

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

startBuild_registryCredentialOverride :: Lens' StartBuild (Maybe RegistryCredential)

The credentials for access to a private registry.

startBuild_reportBuildStatusOverride :: Lens' StartBuild (Maybe Bool)

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 CodeBuild User Guide.

The status of a build triggered by a webhook is always reported to your source provider.

startBuild_secondaryArtifactsOverride :: Lens' StartBuild (Maybe [ProjectArtifacts])

An array of ProjectArtifacts objects.

startBuild_secondarySourcesOverride :: Lens' StartBuild (Maybe [ProjectSource])

An array of ProjectSource objects.

startBuild_secondarySourcesVersionOverride :: Lens' StartBuild (Maybe [ProjectSourceVersion])

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

startBuild_serviceRoleOverride :: Lens' StartBuild (Maybe Text)

The name of a service role for this build that overrides the one specified in the build project.

startBuild_sourceAuthOverride :: Lens' StartBuild (Maybe SourceAuth)

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.

startBuild_sourceLocationOverride :: Lens' StartBuild (Maybe Text)

A location that overrides, for this build, the source location for the one defined in the build project.

startBuild_sourceTypeOverride :: Lens' StartBuild (Maybe SourceType)

A source input type, for this build, that overrides the source input defined in the build project.

startBuild_sourceVersion :: Lens' StartBuild (Maybe Text)

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:

CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for 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.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

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

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

startBuild_timeoutInMinutesOverride :: Lens' StartBuild (Maybe Natural)

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.

startBuild_projectName :: Lens' StartBuild Text

The name of the CodeBuild build project to start running a build.

startBuildResponse_build :: Lens' StartBuildResponse (Maybe Build)

Information about the build to be run.

startBuildResponse_httpStatus :: Lens' StartBuildResponse Int

The response's http status code.

StartBuildBatch

startBuildBatch_artifactsOverride :: Lens' StartBuildBatch (Maybe ProjectArtifacts)

An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

startBuildBatch_buildBatchConfigOverride :: Lens' StartBuildBatch (Maybe ProjectBuildBatchConfig)

A BuildBatchConfigOverride object that contains batch build configuration overrides.

startBuildBatch_buildTimeoutInMinutesOverride :: Lens' StartBuildBatch (Maybe Natural)

Overrides the build timeout specified in the batch build project.

startBuildBatch_buildspecOverride :: Lens' StartBuildBatch (Maybe Text)

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

startBuildBatch_cacheOverride :: Lens' StartBuildBatch (Maybe ProjectCache)

A ProjectCache object that specifies cache overrides.

startBuildBatch_certificateOverride :: Lens' StartBuildBatch (Maybe Text)

The name of a certificate for this batch build that overrides the one specified in the batch build project.

startBuildBatch_computeTypeOverride :: Lens' StartBuildBatch (Maybe ComputeType)

The name of a compute type for this batch build that overrides the one specified in the batch build project.

startBuildBatch_debugSessionEnabled :: Lens' StartBuildBatch (Maybe Bool)

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.

startBuildBatch_encryptionKeyOverride :: Lens' StartBuildBatch (Maybe Text)

The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

startBuildBatch_environmentTypeOverride :: Lens' StartBuildBatch (Maybe EnvironmentType)

A container type for this batch build that overrides the one specified in the batch build project.

startBuildBatch_environmentVariablesOverride :: Lens' StartBuildBatch (Maybe [EnvironmentVariable])

An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

startBuildBatch_gitCloneDepthOverride :: Lens' StartBuildBatch (Maybe Natural)

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.

startBuildBatch_gitSubmodulesConfigOverride :: Lens' StartBuildBatch (Maybe GitSubmodulesConfig)

A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

startBuildBatch_idempotencyToken :: Lens' StartBuildBatch (Maybe Text)

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, CodeBuild returns a parameter mismatch error.

startBuildBatch_imageOverride :: Lens' StartBuildBatch (Maybe Text)

The name of an image for this batch build that overrides the one specified in the batch build project.

startBuildBatch_imagePullCredentialsTypeOverride :: Lens' StartBuildBatch (Maybe ImagePullCredentialsType)

The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

startBuildBatch_insecureSslOverride :: Lens' StartBuildBatch (Maybe Bool)

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.

startBuildBatch_logsConfigOverride :: Lens' StartBuildBatch (Maybe LogsConfig)

A LogsConfig object that override the log settings defined in the batch build project.

startBuildBatch_privilegedModeOverride :: Lens' StartBuildBatch (Maybe Bool)

Enable this flag to override privileged mode in the batch build project.

startBuildBatch_queuedTimeoutInMinutesOverride :: Lens' StartBuildBatch (Maybe Natural)

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

startBuildBatch_registryCredentialOverride :: Lens' StartBuildBatch (Maybe RegistryCredential)

A RegistryCredential object that overrides credentials for access to a private registry.

startBuildBatch_reportBuildBatchStatusOverride :: Lens' StartBuildBatch (Maybe Bool)

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.

startBuildBatch_secondaryArtifactsOverride :: Lens' StartBuildBatch (Maybe [ProjectArtifacts])

An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.

startBuildBatch_secondarySourcesOverride :: Lens' StartBuildBatch (Maybe [ProjectSource])

An array of ProjectSource objects that override the secondary sources defined in the batch build project.

startBuildBatch_secondarySourcesVersionOverride :: Lens' StartBuildBatch (Maybe [ProjectSourceVersion])

An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.

startBuildBatch_serviceRoleOverride :: Lens' StartBuildBatch (Maybe Text)

The name of a service role for this batch build that overrides the one specified in the batch build project.

startBuildBatch_sourceAuthOverride :: Lens' StartBuildBatch (Maybe SourceAuth)

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.

startBuildBatch_sourceLocationOverride :: Lens' StartBuildBatch (Maybe Text)

A location that overrides, for this batch build, the source location defined in the batch build project.

startBuildBatch_sourceTypeOverride :: Lens' StartBuildBatch (Maybe SourceType)

The source input type that overrides the source input defined in the batch build project.

startBuildBatch_sourceVersion :: Lens' StartBuildBatch (Maybe Text)

The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for 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.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

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

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

startBuildBatch_projectName :: Lens' StartBuildBatch Text

The name of the project.

startBuildBatchResponse_buildBatch :: Lens' StartBuildBatchResponse (Maybe BuildBatch)

A BuildBatch object that contains information about the batch build.

startBuildBatchResponse_httpStatus :: Lens' StartBuildBatchResponse Int

The response's http status code.

StopBuild

stopBuild_id :: Lens' StopBuild Text

The ID of the build.

stopBuildResponse_build :: Lens' StopBuildResponse (Maybe Build)

Information about the build.

stopBuildResponse_httpStatus :: Lens' StopBuildResponse Int

The response's http status code.

StopBuildBatch

stopBuildBatch_id :: Lens' StopBuildBatch Text

The identifier of the batch build to stop.

stopBuildBatchResponse_buildBatch :: Lens' StopBuildBatchResponse (Maybe BuildBatch)

Undocumented member.

stopBuildBatchResponse_httpStatus :: Lens' StopBuildBatchResponse Int

The response's http status code.

UpdateProject

updateProject_artifacts :: Lens' UpdateProject (Maybe ProjectArtifacts)

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

updateProject_badgeEnabled :: Lens' UpdateProject (Maybe Bool)

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

updateProject_buildBatchConfig :: Lens' UpdateProject (Maybe ProjectBuildBatchConfig)

Undocumented member.

updateProject_cache :: Lens' UpdateProject (Maybe ProjectCache)

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

updateProject_concurrentBuildLimit :: Lens' UpdateProject (Maybe Int)

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.

updateProject_description :: Lens' UpdateProject (Maybe Text)

A new or replacement description of the build project.

updateProject_encryptionKey :: Lens' UpdateProject (Maybe Text)

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

updateProject_environment :: Lens' UpdateProject (Maybe ProjectEnvironment)

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

updateProject_fileSystemLocations :: Lens' UpdateProject (Maybe [ProjectFileSystemLocation])

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.

updateProject_logsConfig :: Lens' UpdateProject (Maybe LogsConfig)

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

updateProject_queuedTimeoutInMinutes :: Lens' UpdateProject (Maybe Natural)

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

updateProject_secondaryArtifacts :: Lens' UpdateProject (Maybe [ProjectArtifacts])

An array of ProjectArtifact objects.

updateProject_secondarySourceVersions :: Lens' UpdateProject (Maybe [ProjectSourceVersion])

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

updateProject_secondarySources :: Lens' UpdateProject (Maybe [ProjectSource])

An array of ProjectSource objects.

updateProject_serviceRole :: Lens' UpdateProject (Maybe Text)

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

updateProject_source :: Lens' UpdateProject (Maybe ProjectSource)

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

updateProject_sourceVersion :: Lens' UpdateProject (Maybe Text)

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

• For CodeCommit: the commit ID, branch, or Git tag to use.
• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

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

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

updateProject_tags :: Lens' UpdateProject (Maybe [Tag])

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

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

updateProject_timeoutInMinutes :: Lens' UpdateProject (Maybe Natural)

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

updateProject_vpcConfig :: Lens' UpdateProject (Maybe VpcConfig)

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

updateProject_name :: Lens' UpdateProject Text

The name of the build project.

You cannot change a build project's name.

updateProjectResponse_project :: Lens' UpdateProjectResponse (Maybe Project)

Information about the build project that was changed.

updateProjectResponse_httpStatus :: Lens' UpdateProjectResponse Int

The response's http status code.

UpdateProjectVisibility

updateProjectVisibility_resourceAccessRole :: Lens' UpdateProjectVisibility (Maybe Text)

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

updateProjectVisibility_projectArn :: Lens' UpdateProjectVisibility Text

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

updateProjectVisibility_projectVisibility :: Lens' UpdateProjectVisibility ProjectVisibilityType

Undocumented member.

updateProjectVisibilityResponse_projectArn :: Lens' UpdateProjectVisibilityResponse (Maybe Text)

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

updateProjectVisibilityResponse_projectVisibility :: Lens' UpdateProjectVisibilityResponse (Maybe ProjectVisibilityType)

Undocumented member.

updateProjectVisibilityResponse_publicProjectAlias :: Lens' UpdateProjectVisibilityResponse (Maybe Text)

Contains the project identifier used with the public build APIs.

updateProjectVisibilityResponse_httpStatus :: Lens' UpdateProjectVisibilityResponse Int

The response's http status code.

UpdateReportGroup

updateReportGroup_exportConfig :: Lens' UpdateReportGroup (Maybe ReportExportConfig)

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.

updateReportGroup_tags :: Lens' UpdateReportGroup (Maybe [Tag])

An updated list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

updateReportGroup_arn :: Lens' UpdateReportGroup Text

The ARN of the report group to update.

updateReportGroupResponse_reportGroup :: Lens' UpdateReportGroupResponse (Maybe ReportGroup)

Information about the updated report group.

updateReportGroupResponse_httpStatus :: Lens' UpdateReportGroupResponse Int

The response's http status code.

UpdateWebhook

updateWebhook_branchFilter :: Lens' UpdateWebhook (Maybe Text)

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.

updateWebhook_buildType :: Lens' UpdateWebhook (Maybe WebhookBuildType)

Specifies the type of build this webhook will trigger.

updateWebhook_filterGroups :: Lens' UpdateWebhook (Maybe [[WebhookFilter]])

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.

updateWebhook_rotateSecret :: Lens' UpdateWebhook (Maybe Bool)

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.

updateWebhook_projectName :: Lens' UpdateWebhook Text

The name of the CodeBuild project.

updateWebhookResponse_webhook :: Lens' UpdateWebhookResponse (Maybe Webhook)

Information about a repository's webhook that is associated with a project in CodeBuild.

updateWebhookResponse_httpStatus :: Lens' UpdateWebhookResponse Int

The response's http status code.

Types

BatchRestrictions

batchRestrictions_computeTypesAllowed :: Lens' BatchRestrictions (Maybe [Text])

An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the CodeBuild User Guide for these values.

batchRestrictions_maximumBuildsAllowed :: Lens' BatchRestrictions (Maybe Int)

Specifies the maximum number of builds allowed.

Build

build_arn :: Lens' Build (Maybe Text)

The Amazon Resource Name (ARN) of the build.

build_artifacts :: Lens' Build (Maybe BuildArtifacts)

Information about the output artifacts for the build.

build_buildBatchArn :: Lens' Build (Maybe Text)

The ARN of the batch build that this build is a member of, if applicable.

build_buildComplete :: Lens' Build (Maybe Bool)

Whether the build is complete. True if complete; otherwise, false.

build_buildNumber :: Lens' Build (Maybe Integer)

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.

build_buildStatus :: Lens' Build (Maybe StatusType)

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.

build_cache :: Lens' Build (Maybe ProjectCache)

Information about the cache for the build.

build_currentPhase :: Lens' Build (Maybe Text)

The current build phase.

build_debugSession :: Lens' Build (Maybe DebugSession)

Contains information about the debug session for this build.

build_encryptionKey :: Lens' Build (Maybe Text)

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

build_endTime :: Lens' Build (Maybe UTCTime)

When the build process ended, expressed in Unix time format.

build_environment :: Lens' Build (Maybe ProjectEnvironment)

Information about the build environment for this build.

build_exportedEnvironmentVariables :: Lens' Build (Maybe [ExportedEnvironmentVariable])

A list of exported environment variables for this build.

Exported environment variables are used in conjunction with 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 CodePipeline User Guide.

build_fileSystemLocations :: Lens' Build (Maybe [ProjectFileSystemLocation])

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.

build_id :: Lens' Build (Maybe Text)

The unique ID for the build.

build_initiator :: Lens' Build (Maybe Text)

The entity that started the build. Valid values include:

• If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).
• If an IAM user started the build, the user's name (for example, MyUserName).
• If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

build_logs :: Lens' Build (Maybe LogsLocation)

Information about the build's logs in CloudWatch Logs.

build_networkInterface :: Lens' Build (Maybe NetworkInterface)

Describes a network interface.

build_phases :: Lens' Build (Maybe [BuildPhase])

Information about all previous build phases that are complete and information about any current build phase that is not yet complete.

build_projectName :: Lens' Build (Maybe Text)

The name of the CodeBuild project.

build_queuedTimeoutInMinutes :: Lens' Build (Maybe Int)

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

build_reportArns :: Lens' Build (Maybe [Text])

An array of the ARNs associated with this build's reports.

build_resolvedSourceVersion :: Lens' Build (Maybe Text)

An identifier for the version of this build's source code.

• For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
• For CodePipeline, the source revision provided by CodePipeline.
• For Amazon S3, this does not apply.

build_secondaryArtifacts :: Lens' Build (Maybe [BuildArtifacts])

An array of ProjectArtifacts objects.

build_secondarySourceVersions :: Lens' Build (Maybe [ProjectSourceVersion])

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.
• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
• For 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.

build_secondarySources :: Lens' Build (Maybe [ProjectSource])

An array of ProjectSource objects.

build_serviceRole :: Lens' Build (Maybe Text)

The name of a service role used for this build.

build_source :: Lens' Build (Maybe ProjectSource)

Information about the source code to be built.

build_sourceVersion :: Lens' Build (Maybe Text)

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 CodeBuild User Guide.

build_startTime :: Lens' Build (Maybe UTCTime)

When the build process started, expressed in Unix time format.

build_timeoutInMinutes :: Lens' Build (Maybe Int)

How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.

build_vpcConfig :: Lens' Build (Maybe VpcConfig)

If your 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.

BuildArtifacts

buildArtifacts_artifactIdentifier :: Lens' BuildArtifacts (Maybe Text)

An identifier for this artifact definition.

buildArtifacts_bucketOwnerAccess :: Lens' BuildArtifacts (Maybe BucketOwnerAccess)

Undocumented member.

buildArtifacts_encryptionDisabled :: Lens' BuildArtifacts (Maybe Bool)

Information that tells you if encryption for build artifacts is disabled.

buildArtifacts_location :: Lens' BuildArtifacts (Maybe Text)

Information about the location of the build artifacts.

buildArtifacts_md5sum :: Lens' BuildArtifacts (Maybe Text)

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.

buildArtifacts_overrideArtifactName :: Lens' BuildArtifacts (Maybe Bool)

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.

buildArtifacts_sha256sum :: Lens' BuildArtifacts (Maybe Text)

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.

BuildBatch

buildBatch_arn :: Lens' BuildBatch (Maybe Text)

The ARN of the batch build.

buildBatch_artifacts :: Lens' BuildBatch (Maybe BuildArtifacts)

A BuildArtifacts object the defines the build artifacts for this batch build.

buildBatch_buildBatchConfig :: Lens' BuildBatch (Maybe ProjectBuildBatchConfig)

Undocumented member.

buildBatch_buildBatchNumber :: Lens' BuildBatch (Maybe Integer)

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.

buildBatch_buildBatchStatus :: Lens' BuildBatch (Maybe StatusType)

The status of the batch build.

buildBatch_buildGroups :: Lens' BuildBatch (Maybe [BuildGroup])

An array of BuildGroup objects that define the build groups for the batch build.

buildBatch_buildTimeoutInMinutes :: Lens' BuildBatch (Maybe Int)

Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.

buildBatch_cache :: Lens' BuildBatch (Maybe ProjectCache)

Undocumented member.

buildBatch_complete :: Lens' BuildBatch (Maybe Bool)

Indicates if the batch build is complete.

buildBatch_currentPhase :: Lens' BuildBatch (Maybe Text)

The current phase of the batch build.

buildBatch_debugSessionEnabled :: Lens' BuildBatch (Maybe Bool)

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_encryptionKey :: Lens' BuildBatch (Maybe Text)

The Key Management Service 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>).

buildBatch_endTime :: Lens' BuildBatch (Maybe UTCTime)

The date and time that the batch build ended.

buildBatch_environment :: Lens' BuildBatch (Maybe ProjectEnvironment)

Undocumented member.

buildBatch_fileSystemLocations :: Lens' BuildBatch (Maybe [ProjectFileSystemLocation])

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.

buildBatch_id :: Lens' BuildBatch (Maybe Text)

The identifier of the batch build.

buildBatch_initiator :: Lens' BuildBatch (Maybe Text)

The entity that started the batch build. Valid values include:

• If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).
• If an IAM user started the build, the user's name.
• If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

buildBatch_logConfig :: Lens' BuildBatch (Maybe LogsConfig)

Undocumented member.

buildBatch_phases :: Lens' BuildBatch (Maybe [BuildBatchPhase])

An array of BuildBatchPhase objects the specify the phases of the batch build.

buildBatch_projectName :: Lens' BuildBatch (Maybe Text)

The name of the batch build project.

buildBatch_queuedTimeoutInMinutes :: Lens' BuildBatch (Maybe Int)

Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.

buildBatch_resolvedSourceVersion :: Lens' BuildBatch (Maybe Text)

The identifier of the resolved version of this batch build's source code.

• For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
• For CodePipeline, the source revision provided by CodePipeline.
• For Amazon S3, this does not apply.

buildBatch_secondaryArtifacts :: Lens' BuildBatch (Maybe [BuildArtifacts])

An array of BuildArtifacts objects the define the build artifacts for this batch build.

buildBatch_secondarySourceVersions :: Lens' BuildBatch (Maybe [ProjectSourceVersion])

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.
• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
• For 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.

buildBatch_secondarySources :: Lens' BuildBatch (Maybe [ProjectSource])

An array of ProjectSource objects that define the sources for the batch build.

buildBatch_serviceRole :: Lens' BuildBatch (Maybe Text)

The name of a service role used for builds in the batch.

buildBatch_source :: Lens' BuildBatch (Maybe ProjectSource)

Undocumented member.

buildBatch_sourceVersion :: Lens' BuildBatch (Maybe Text)

The identifier of the version of the source code to be built.

buildBatch_startTime :: Lens' BuildBatch (Maybe UTCTime)

The date and time that the batch build started.

buildBatch_vpcConfig :: Lens' BuildBatch (Maybe VpcConfig)

Undocumented member.

BuildBatchFilter

buildBatchFilter_status :: Lens' BuildBatchFilter (Maybe StatusType)

The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved.

BuildBatchPhase

buildBatchPhase_contexts :: Lens' BuildBatchPhase (Maybe [PhaseContext])

Additional information about the batch build phase. Especially to help troubleshoot a failed batch build.

buildBatchPhase_durationInSeconds :: Lens' BuildBatchPhase (Maybe Integer)

How long, in seconds, between the starting and ending times of the batch build's phase.

buildBatchPhase_endTime :: Lens' BuildBatchPhase (Maybe UTCTime)

When the batch build phase ended, expressed in Unix time format.

buildBatchPhase_phaseStatus :: Lens' BuildBatchPhase (Maybe StatusType)

The current status of the batch build phase. Valid values include:

FAILED

The build phase failed.

FAULT

The build phase faulted.

IN_PROGRESS

The build phase is still in progress.

STOPPED

The build phase stopped.

SUCCEEDED

The build phase succeeded.

TIMED_OUT

The build phase timed out.

buildBatchPhase_phaseType :: Lens' BuildBatchPhase (Maybe BuildBatchPhaseType)

The name of the batch build phase. Valid values include:

COMBINE_ARTIFACTS

Build output artifacts are being combined and uploaded to the output location.

DOWNLOAD_BATCHSPEC

The batch build specification is being downloaded.

FAILED

One or more of the builds failed.

IN_PROGRESS

The batch build is in progress.

STOPPED

The batch build was stopped.

SUBMITTED

The btach build has been submitted.

SUCCEEDED

The batch build succeeded.

buildBatchPhase_startTime :: Lens' BuildBatchPhase (Maybe UTCTime)

When the batch build phase started, expressed in Unix time format.

BuildGroup

buildGroup_currentBuildSummary :: Lens' BuildGroup (Maybe BuildSummary)

A BuildSummary object that contains a summary of the current build group.

buildGroup_dependsOn :: Lens' BuildGroup (Maybe [Text])

An array of strings that contain the identifiers of the build groups that this build group depends on.

buildGroup_identifier :: Lens' BuildGroup (Maybe Text)

Contains the identifier of the build group.

buildGroup_ignoreFailure :: Lens' BuildGroup (Maybe Bool)

Specifies if failures in this build group can be ignored.

buildGroup_priorBuildSummaryList :: Lens' BuildGroup (Maybe [BuildSummary])

An array of BuildSummary objects that contain summaries of previous build groups.

BuildNotDeleted

buildNotDeleted_id :: Lens' BuildNotDeleted (Maybe Text)

The ID of the build that could not be successfully deleted.

buildNotDeleted_statusCode :: Lens' BuildNotDeleted (Maybe Text)

Additional information about the build that could not be successfully deleted.

BuildPhase

buildPhase_contexts :: Lens' BuildPhase (Maybe [PhaseContext])

Additional information about a build phase, especially to help troubleshoot a failed build.

buildPhase_durationInSeconds :: Lens' BuildPhase (Maybe Integer)

How long, in seconds, between the starting and ending times of the build's phase.

buildPhase_endTime :: Lens' BuildPhase (Maybe UTCTime)

When the build phase ended, expressed in Unix time format.

buildPhase_phaseStatus :: Lens' BuildPhase (Maybe StatusType)

The current status of the build phase. Valid values include:

FAILED

The build phase failed.

FAULT

The build phase faulted.

IN_PROGRESS

The build phase is still in progress.

STOPPED

The build phase stopped.

SUCCEEDED

The build phase succeeded.

TIMED_OUT

The build phase timed out.

buildPhase_phaseType :: Lens' BuildPhase (Maybe BuildPhaseType)

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.

buildPhase_startTime :: Lens' BuildPhase (Maybe UTCTime)

When the build phase started, expressed in Unix time format.

BuildStatusConfig

buildStatusConfig_context :: Lens' BuildStatusConfig (Maybe Text)

Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.

Bitbucket

This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

GitHub/GitHub Enterprise Server

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.

buildStatusConfig_targetUrl :: Lens' BuildStatusConfig (Maybe Text)

Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.

Bitbucket

This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

GitHub/GitHub Enterprise Server

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.

BuildSummary

buildSummary_arn :: Lens' BuildSummary (Maybe Text)

The batch build ARN.

buildSummary_buildStatus :: Lens' BuildSummary (Maybe StatusType)

The status of the build group.

FAILED

The build group failed.

FAULT

The build group faulted.

IN_PROGRESS

The build group is still in progress.

STOPPED

The build group stopped.

SUCCEEDED

The build group succeeded.

TIMED_OUT

The build group timed out.

buildSummary_primaryArtifact :: Lens' BuildSummary (Maybe ResolvedArtifact)

A ResolvedArtifact object that represents the primary build artifacts for the build group.

buildSummary_requestedOn :: Lens' BuildSummary (Maybe UTCTime)

When the build was started, expressed in Unix time format.

buildSummary_secondaryArtifacts :: Lens' BuildSummary (Maybe [ResolvedArtifact])

An array of ResolvedArtifact objects that represents the secondary build artifacts for the build group.

CloudWatchLogsConfig

cloudWatchLogsConfig_groupName :: Lens' CloudWatchLogsConfig (Maybe Text)

The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

cloudWatchLogsConfig_streamName :: Lens' CloudWatchLogsConfig (Maybe Text)

The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

cloudWatchLogsConfig_status :: Lens' CloudWatchLogsConfig LogsConfigStatusType

The current status of the logs in CloudWatch Logs for a build project. Valid values are:

• ENABLED: CloudWatch Logs are enabled for this build project.
• DISABLED: CloudWatch Logs are not enabled for this build project.

CodeCoverage

codeCoverage_branchCoveragePercentage :: Lens' CodeCoverage (Maybe Double)

The percentage of branches that are covered by your tests.

codeCoverage_branchesCovered :: Lens' CodeCoverage (Maybe Natural)

The number of conditional branches that are covered by your tests.

codeCoverage_branchesMissed :: Lens' CodeCoverage (Maybe Natural)

The number of conditional branches that are not covered by your tests.

codeCoverage_expired :: Lens' CodeCoverage (Maybe UTCTime)

The date and time that the tests were run.

codeCoverage_filePath :: Lens' CodeCoverage (Maybe Text)

The path of the test report file.

codeCoverage_id :: Lens' CodeCoverage (Maybe Text)

The identifier of the code coverage report.

codeCoverage_lineCoveragePercentage :: Lens' CodeCoverage (Maybe Double)

The percentage of lines that are covered by your tests.

codeCoverage_linesCovered :: Lens' CodeCoverage (Maybe Natural)

The number of lines that are covered by your tests.

codeCoverage_linesMissed :: Lens' CodeCoverage (Maybe Natural)

The number of lines that are not covered by your tests.

codeCoverage_reportARN :: Lens' CodeCoverage (Maybe Text)

The ARN of the report.

CodeCoverageReportSummary

codeCoverageReportSummary_branchCoveragePercentage :: Lens' CodeCoverageReportSummary (Maybe Double)

The percentage of branches that are covered by your tests.

codeCoverageReportSummary_branchesCovered :: Lens' CodeCoverageReportSummary (Maybe Natural)

The number of conditional branches that are covered by your tests.

codeCoverageReportSummary_branchesMissed :: Lens' CodeCoverageReportSummary (Maybe Natural)

The number of conditional branches that are not covered by your tests.

codeCoverageReportSummary_lineCoveragePercentage :: Lens' CodeCoverageReportSummary (Maybe Double)

The percentage of lines that are covered by your tests.

codeCoverageReportSummary_linesCovered :: Lens' CodeCoverageReportSummary (Maybe Natural)

The number of lines that are covered by your tests.

codeCoverageReportSummary_linesMissed :: Lens' CodeCoverageReportSummary (Maybe Natural)

The number of lines that are not covered by your tests.

DebugSession

debugSession_sessionEnabled :: Lens' DebugSession (Maybe Bool)

Specifies if session debugging is enabled for this build.

debugSession_sessionTarget :: Lens' DebugSession (Maybe Text)

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.

EnvironmentImage

environmentImage_description :: Lens' EnvironmentImage (Maybe Text)

The description of the Docker image.

environmentImage_name :: Lens' EnvironmentImage (Maybe Text)

The name of the Docker image.

environmentImage_versions :: Lens' EnvironmentImage (Maybe [Text])

A list of environment image versions.

EnvironmentLanguage

environmentLanguage_images :: Lens' EnvironmentLanguage (Maybe [EnvironmentImage])

The list of Docker images that are related by the specified programming language.

environmentLanguage_language :: Lens' EnvironmentLanguage (Maybe LanguageType)

The programming language for the Docker images.

EnvironmentPlatform

environmentPlatform_languages :: Lens' EnvironmentPlatform (Maybe [EnvironmentLanguage])

The list of programming languages that are available for the specified platform.

environmentPlatform_platform :: Lens' EnvironmentPlatform (Maybe PlatformType)

The platform's name.

EnvironmentVariable

environmentVariable_type :: Lens' EnvironmentVariable (Maybe EnvironmentVariableType)

The type of environment variable. Valid values include:

• PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. To learn how to specify a parameter store environment variable, see env/parameter-store in the CodeBuild User Guide.
• PLAINTEXT: An environment variable in plain text format. This is the default value.
• SECRETS_MANAGER: An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager in the CodeBuild User Guide.

environmentVariable_name :: Lens' EnvironmentVariable Text

The name or key of the environment variable.

environmentVariable_value :: Lens' EnvironmentVariable Text

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs and secret access keys. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

ExportedEnvironmentVariable

exportedEnvironmentVariable_name :: Lens' ExportedEnvironmentVariable (Maybe Text)

The name of the exported environment variable.

exportedEnvironmentVariable_value :: Lens' ExportedEnvironmentVariable (Maybe Text)

The value assigned to the exported environment variable.

GitSubmodulesConfig

gitSubmodulesConfig_fetchSubmodules :: Lens' GitSubmodulesConfig Bool

Set to true to fetch Git submodules for your CodeBuild build project.

LogsConfig

logsConfig_cloudWatchLogs :: Lens' LogsConfig (Maybe CloudWatchLogsConfig)

Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.

logsConfig_s3Logs :: Lens' LogsConfig (Maybe S3LogsConfig)

Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.

LogsLocation

logsLocation_cloudWatchLogs :: Lens' LogsLocation (Maybe CloudWatchLogsConfig)

Information about CloudWatch Logs for a build project.

logsLocation_cloudWatchLogsArn :: Lens' LogsLocation (Maybe Text)

The ARN of 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 CloudWatch Logs.

logsLocation_deepLink :: Lens' LogsLocation (Maybe Text)

The URL to an individual build log in CloudWatch Logs.

logsLocation_groupName :: Lens' LogsLocation (Maybe Text)

The name of the CloudWatch Logs group for the build logs.

logsLocation_s3DeepLink :: Lens' LogsLocation (Maybe Text)

The URL to a build log in an S3 bucket.

logsLocation_s3Logs :: Lens' LogsLocation (Maybe S3LogsConfig)

Information about S3 logs for a build project.

logsLocation_s3LogsArn :: Lens' LogsLocation (Maybe Text)

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.

logsLocation_streamName :: Lens' LogsLocation (Maybe Text)

The name of the CloudWatch Logs stream for the build logs.

NetworkInterface

networkInterface_networkInterfaceId :: Lens' NetworkInterface (Maybe Text)

The ID of the network interface.

networkInterface_subnetId :: Lens' NetworkInterface (Maybe Text)

The ID of the subnet.

PhaseContext

phaseContext_message :: Lens' PhaseContext (Maybe Text)

An explanation of the build phase's context. This might include a command ID and an exit code.

phaseContext_statusCode :: Lens' PhaseContext (Maybe Text)

The status code for the context of the build phase.

Project

project_arn :: Lens' Project (Maybe Text)

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

project_artifacts :: Lens' Project (Maybe ProjectArtifacts)

Information about the build output artifacts for the build project.

project_badge :: Lens' Project (Maybe ProjectBadge)

Information about the build badge for the build project.

project_buildBatchConfig :: Lens' Project (Maybe ProjectBuildBatchConfig)

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

project_cache :: Lens' Project (Maybe ProjectCache)

Information about the cache for the build project.

project_concurrentBuildLimit :: Lens' Project (Maybe Int)

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_created :: Lens' Project (Maybe UTCTime)

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

project_description :: Lens' Project (Maybe Text)

A description that makes the build project easy to identify.

project_encryptionKey :: Lens' Project (Maybe Text)

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

project_environment :: Lens' Project (Maybe ProjectEnvironment)

Information about the build environment for this build project.

project_fileSystemLocations :: Lens' Project (Maybe [ProjectFileSystemLocation])

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.

project_lastModified :: Lens' Project (Maybe UTCTime)

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

project_logsConfig :: Lens' Project (Maybe LogsConfig)

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

project_name :: Lens' Project (Maybe Text)

The name of the build project.

project_projectVisibility :: Lens' Project (Maybe ProjectVisibilityType)

Undocumented member.

project_publicProjectAlias :: Lens' Project (Maybe Text)

Contains the project identifier used with the public build APIs.

project_queuedTimeoutInMinutes :: Lens' Project (Maybe Natural)

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

project_resourceAccessRole :: Lens' Project (Maybe Text)

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

project_secondaryArtifacts :: Lens' Project (Maybe [ProjectArtifacts])

An array of ProjectArtifacts objects.

project_secondarySourceVersions :: Lens' Project (Maybe [ProjectSourceVersion])

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

project_secondarySources :: Lens' Project (Maybe [ProjectSource])

An array of ProjectSource objects.

project_serviceRole :: Lens' Project (Maybe Text)

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

project_source :: Lens' Project (Maybe ProjectSource)

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

project_sourceVersion :: Lens' Project (Maybe Text)

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

• For CodeCommit: the commit ID, branch, or Git tag to use.
• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

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

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

project_tags :: Lens' Project (Maybe [Tag])

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

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

project_timeoutInMinutes :: Lens' Project (Maybe Natural)

How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

project_vpcConfig :: Lens' Project (Maybe VpcConfig)

Information about the VPC configuration that CodeBuild accesses.

project_webhook :: Lens' Project (Maybe Webhook)

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

ProjectArtifacts

projectArtifacts_artifactIdentifier :: Lens' ProjectArtifacts (Maybe Text)

An identifier for this artifact definition.

projectArtifacts_bucketOwnerAccess :: Lens' ProjectArtifacts (Maybe BucketOwnerAccess)

Undocumented member.

projectArtifacts_encryptionDisabled :: Lens' ProjectArtifacts (Maybe Bool)

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.

projectArtifacts_location :: Lens' ProjectArtifacts (Maybe Text)

Information about the build output artifact location:

• If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of 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.

projectArtifacts_name :: Lens' ProjectArtifacts (Maybe Text)

Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:

• If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of 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>.

projectArtifacts_namespaceType :: Lens' ProjectArtifacts (Maybe ArtifactNamespace)

Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:

• If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of 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.

projectArtifacts_overrideArtifactName :: Lens' ProjectArtifacts (Maybe Bool)

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.

projectArtifacts_packaging :: Lens' ProjectArtifacts (Maybe ArtifactPackaging)

The type of build output artifact to create:

• If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of 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: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.
  • ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.

projectArtifacts_path :: Lens' ProjectArtifacts (Maybe Text)

Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:

• If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of 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.

projectArtifacts_type :: Lens' ProjectArtifacts ArtifactsType

The type of build output artifact. Valid values include:

• CODEPIPELINE: The build project has build output generated through 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.

ProjectBadge

projectBadge_badgeEnabled :: Lens' ProjectBadge (Maybe Bool)

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

projectBadge_badgeRequestUrl :: Lens' ProjectBadge (Maybe Text)

The publicly-accessible URL through which you can access the build badge for your project.

ProjectBuildBatchConfig

projectBuildBatchConfig_batchReportMode :: Lens' ProjectBuildBatchConfig (Maybe BatchReportModeType)

Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.

REPORT_AGGREGATED_BATCH Aggregate all of the build statuses into a single status report.

REPORT_INDIVIDUAL_BUILDS

Send a separate status report for each individual build.

projectBuildBatchConfig_combineArtifacts :: Lens' ProjectBuildBatchConfig (Maybe Bool)

Specifies if the build artifacts for the batch build should be combined into a single artifact location.

projectBuildBatchConfig_restrictions :: Lens' ProjectBuildBatchConfig (Maybe BatchRestrictions)

A BatchRestrictions object that specifies the restrictions for the batch build.

projectBuildBatchConfig_serviceRole :: Lens' ProjectBuildBatchConfig (Maybe Text)

Specifies the service role ARN for the batch build project.

projectBuildBatchConfig_timeoutInMins :: Lens' ProjectBuildBatchConfig (Maybe Int)

Specifies the maximum amount of time, in minutes, that the batch build must be completed in.

ProjectCache

projectCache_location :: Lens' ProjectCache (Maybe Text)

Information about the cache location:

• NO_CACHE or LOCAL: This value is ignored.
• S3: This is the S3 bucket name/prefix.

projectCache_modes :: Lens' ProjectCache (Maybe [CacheMode])

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:

LOCAL_SOURCE_CACHE

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.

LOCAL_DOCKER_LAYER_CACHE

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.

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

projectCache_type :: Lens' ProjectCache CacheType

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.

ProjectEnvironment

projectEnvironment_certificate :: Lens' ProjectEnvironment (Maybe Text)

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 CodeBuild User Guide.

projectEnvironment_environmentVariables :: Lens' ProjectEnvironment (Maybe [EnvironmentVariable])

A set of environment variables to make available to builds for this build project.

projectEnvironment_imagePullCredentialsType :: Lens' ProjectEnvironment (Maybe ImagePullCredentialsType)

The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

• CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal.
• SERVICE_ROLE specifies that 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 CodeBuild curated image, you must use CODEBUILD credentials.

projectEnvironment_privilegedMode :: Lens' ProjectEnvironment (Maybe Bool)

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"

projectEnvironment_registryCredential :: Lens' ProjectEnvironment (Maybe RegistryCredential)

The credentials for access to a private registry.

projectEnvironment_type :: Lens' ProjectEnvironment EnvironmentType

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).
• The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).

For more information, see Build environment compute types in the CodeBuild user guide.

projectEnvironment_image :: Lens' ProjectEnvironment Text

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.

For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.

projectEnvironment_computeType :: Lens' ProjectEnvironment 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 CodeBuild User Guide.

ProjectFileSystemLocation

projectFileSystemLocation_identifier :: Lens' ProjectFileSystemLocation (Maybe Text)

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.

projectFileSystemLocation_location :: Lens' ProjectFileSystemLocation (Maybe Text)

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 Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is 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.

projectFileSystemLocation_mountOptions :: Lens' ProjectFileSystemLocation (Maybe Text)

The mount options for a file system created by Amazon 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.

projectFileSystemLocation_mountPoint :: Lens' ProjectFileSystemLocation (Maybe Text)

The location in the container where you mount the file system.

projectFileSystemLocation_type :: Lens' ProjectFileSystemLocation (Maybe FileSystemType)

The type of the file system. The one supported type is EFS.

ProjectSource

projectSource_auth :: Lens' ProjectSource (Maybe SourceAuth)

Information about the authorization settings for CodeBuild to access the source code to be built.

This information is for the CodeBuild console's use only. Your code should not get or set this information directly.

projectSource_buildStatusConfig :: Lens' ProjectSource (Maybe 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.

projectSource_buildspec :: Lens' ProjectSource (Maybe Text)

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 Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

projectSource_gitCloneDepth :: Lens' ProjectSource (Maybe Natural)

Information about the Git clone depth for the build project.

projectSource_gitSubmodulesConfig :: Lens' ProjectSource (Maybe GitSubmodulesConfig)

Information about the Git submodules configuration for the build project.

projectSource_insecureSsl :: Lens' ProjectSource (Maybe Bool)

Enable this flag to ignore SSL warnings while connecting to the project source code.

projectSource_location :: Lens' ProjectSource (Maybe Text)

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 CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.
• For source code in an 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 Amazon Web Services account to your GitHub account. Use the 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 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 CodeBuild console.) To instruct 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 Amazon Web Services account to your Bitbucket account. Use the 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 CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.

If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify Location.

projectSource_reportBuildStatus :: Lens' ProjectSource (Maybe Bool)

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 CodeBuild User Guide.

The status of a build triggered by a webhook is always reported to your source provider.

If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.

projectSource_sourceIdentifier :: Lens' ProjectSource (Maybe Text)

An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.

projectSource_type :: Lens' ProjectSource SourceType

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 CodeCommit repository.
• CODEPIPELINE: The source code settings are specified in the source action of a pipeline in 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.

ProjectSourceVersion

projectSourceVersion_sourceIdentifier :: Lens' ProjectSourceVersion Text

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.

projectSourceVersion_sourceVersion :: Lens' ProjectSourceVersion Text

The source version for the corresponding source identifier. If specified, must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.
• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
• For 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 CodeBuild User Guide.

RegistryCredential

registryCredential_credential :: Lens' RegistryCredential Text

The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.

The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.

registryCredential_credentialProvider :: Lens' RegistryCredential CredentialProviderType

The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager.

Report

report_arn :: Lens' Report (Maybe Text)

The ARN of the report run.

report_codeCoverageSummary :: Lens' Report (Maybe CodeCoverageReportSummary)

A CodeCoverageReportSummary object that contains a code coverage summary for this report.

report_created :: Lens' Report (Maybe UTCTime)

The date and time this report run occurred.

report_executionId :: Lens' Report (Maybe Text)

The ARN of the build run that generated this report.

report_expired :: Lens' Report (Maybe UTCTime)

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.

report_exportConfig :: Lens' Report (Maybe ReportExportConfig)

Information about where the raw data used to generate this report was exported.

report_name :: Lens' Report (Maybe Text)

The name of the report that was run.

report_reportGroupArn :: Lens' Report (Maybe Text)

The ARN of the report group associated with this report.

report_status :: Lens' Report (Maybe ReportStatusType)

The status of this report.

report_testSummary :: Lens' Report (Maybe TestReportSummary)

A TestReportSummary object that contains information about this test report.

report_truncated :: Lens' Report (Maybe Bool)

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.

report_type :: Lens' Report (Maybe ReportType)

The type of the report that was run.

CODE_COVERAGE

A code coverage report.

TEST

A test report.

ReportExportConfig

reportExportConfig_exportConfigType :: Lens' ReportExportConfig (Maybe ReportExportConfigType)

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.

reportExportConfig_s3Destination :: Lens' ReportExportConfig (Maybe S3ReportExportConfig)

A S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported.

ReportFilter

reportFilter_status :: Lens' ReportFilter (Maybe ReportStatusType)

The status used to filter reports. You can filter using one status only.

ReportGroup

reportGroup_arn :: Lens' ReportGroup (Maybe Text)

The ARN of the ReportGroup.

reportGroup_created :: Lens' ReportGroup (Maybe UTCTime)

The date and time this ReportGroup was created.

reportGroup_exportConfig :: Lens' ReportGroup (Maybe ReportExportConfig)

Information about the destination where the raw data of this ReportGroup is exported.

reportGroup_lastModified :: Lens' ReportGroup (Maybe UTCTime)

The date and time this ReportGroup was last modified.

reportGroup_name :: Lens' ReportGroup (Maybe Text)

The name of the ReportGroup.

reportGroup_status :: Lens' ReportGroup (Maybe ReportGroupStatusType)

The status of the report group. This property is read-only.

This can be one of the following values:

ACTIVE

The report group is active.

DELETING

The report group is in the process of being deleted.

reportGroup_tags :: Lens' ReportGroup (Maybe [Tag])

A list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

reportGroup_type :: Lens' ReportGroup (Maybe ReportType)

The type of the ReportGroup. This can be one of the following values:

CODE_COVERAGE

The report group contains code coverage reports.

TEST

The report group contains test reports.

ReportGroupTrendStats

reportGroupTrendStats_average :: Lens' ReportGroupTrendStats (Maybe Text)

Contains the average of all values analyzed.

reportGroupTrendStats_max :: Lens' ReportGroupTrendStats (Maybe Text)

Contains the maximum value analyzed.

reportGroupTrendStats_min :: Lens' ReportGroupTrendStats (Maybe Text)

Contains the minimum value analyzed.

ReportWithRawData

reportWithRawData_data :: Lens' ReportWithRawData (Maybe Text)

The value of the requested data field from the report.

reportWithRawData_reportArn :: Lens' ReportWithRawData (Maybe Text)

The ARN of the report.

ResolvedArtifact

resolvedArtifact_identifier :: Lens' ResolvedArtifact (Maybe Text)

The identifier of the artifact.

resolvedArtifact_location :: Lens' ResolvedArtifact (Maybe Text)

The location of the artifact.

resolvedArtifact_type :: Lens' ResolvedArtifact (Maybe ArtifactsType)

Specifies the type of artifact.

S3LogsConfig

s3LogsConfig_bucketOwnerAccess :: Lens' S3LogsConfig (Maybe BucketOwnerAccess)

Undocumented member.

s3LogsConfig_encryptionDisabled :: Lens' S3LogsConfig (Maybe Bool)

Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.

s3LogsConfig_location :: Lens' S3LogsConfig (Maybe Text)

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.

s3LogsConfig_status :: Lens' S3LogsConfig LogsConfigStatusType

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.

S3ReportExportConfig

s3ReportExportConfig_bucket :: Lens' S3ReportExportConfig (Maybe Text)

The name of the S3 bucket where the raw data of a report are exported.

s3ReportExportConfig_bucketOwner :: Lens' S3ReportExportConfig (Maybe Text)

The Amazon Web Services 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.

s3ReportExportConfig_encryptionDisabled :: Lens' S3ReportExportConfig (Maybe Bool)

A boolean value that specifies if the results of a report are encrypted.

s3ReportExportConfig_encryptionKey :: Lens' S3ReportExportConfig (Maybe Text)

The encryption key for the report's encrypted raw data.

s3ReportExportConfig_packaging :: Lens' S3ReportExportConfig (Maybe ReportPackagingType)

The type of build output artifact to create. Valid values include:

• NONE: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified.
• ZIP: CodeBuild creates a ZIP file with the raw data in the output bucket.

s3ReportExportConfig_path :: Lens' S3ReportExportConfig (Maybe Text)

The path to the exported report's raw data results.

SourceAuth

sourceAuth_resource :: Lens' SourceAuth (Maybe Text)

The resource value that applies to the specified authorization type.

sourceAuth_type :: Lens' SourceAuth SourceAuthType

This data type is deprecated and is no longer accurate or used.

The authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type.

SourceCredentialsInfo

sourceCredentialsInfo_arn :: Lens' SourceCredentialsInfo (Maybe Text)

The Amazon Resource Name (ARN) of the token.

sourceCredentialsInfo_authType :: Lens' SourceCredentialsInfo (Maybe AuthType)

The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.

sourceCredentialsInfo_serverType :: Lens' SourceCredentialsInfo (Maybe ServerType)

The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

Tag

tag_key :: Lens' Tag (Maybe Text)

The tag's key.

tag_value :: Lens' Tag (Maybe Text)

The tag's value.

TestCase

testCase_durationInNanoSeconds :: Lens' TestCase (Maybe Integer)

The number of nanoseconds it took to run this test case.

testCase_expired :: Lens' TestCase (Maybe UTCTime)

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.

testCase_message :: Lens' TestCase (Maybe Text)

A message associated with a test case. For example, an error message or stack trace.

testCase_name :: Lens' TestCase (Maybe Text)

The name of the test case.

testCase_prefix :: Lens' TestCase (Maybe Text)

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.

testCase_reportArn :: Lens' TestCase (Maybe Text)

The ARN of the report to which the test case belongs.

testCase_status :: Lens' TestCase (Maybe Text)

The status returned by the test case after it was run. Valid statuses are SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN.

testCase_testRawDataPath :: Lens' TestCase (Maybe Text)

The path to the raw data file that contains the test result.

TestCaseFilter

testCaseFilter_keyword :: Lens' TestCaseFilter (Maybe Text)

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.

testCaseFilter_status :: Lens' TestCaseFilter (Maybe Text)

The status used to filter test cases. A TestCaseFilter can have one status. Valid values are:

• SUCCEEDED

• FAILED

• ERROR

• SKIPPED

• UNKNOWN

TestReportSummary

testReportSummary_total :: Lens' TestReportSummary Int

The number of test cases in this TestReportSummary. The total includes truncated test cases.

testReportSummary_statusCounts :: Lens' TestReportSummary (HashMap Text Int)

A map that contains the number of each type of status returned by the test results in this TestReportSummary.

testReportSummary_durationInNanoSeconds :: Lens' TestReportSummary Integer

The number of nanoseconds it took to run all of the test cases in this report.

VpcConfig

vpcConfig_securityGroupIds :: Lens' VpcConfig (Maybe [Text])

A list of one or more security groups IDs in your Amazon VPC.

vpcConfig_subnets :: Lens' VpcConfig (Maybe [Text])

A list of one or more subnet IDs in your Amazon VPC.

vpcConfig_vpcId :: Lens' VpcConfig (Maybe Text)

The ID of the Amazon VPC.

Webhook

webhook_branchFilter :: Lens' Webhook (Maybe Text)

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.

webhook_buildType :: Lens' Webhook (Maybe WebhookBuildType)

Specifies the type of build this webhook will trigger.

webhook_filterGroups :: Lens' Webhook (Maybe [[WebhookFilter]])

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.

webhook_lastModifiedSecret :: Lens' Webhook (Maybe UTCTime)

A timestamp that indicates the last time a repository's secret token was modified.

webhook_payloadUrl :: Lens' Webhook (Maybe Text)

The CodeBuild endpoint where webhook events are sent.

webhook_secret :: Lens' Webhook (Maybe Text)

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

webhook_url :: Lens' Webhook (Maybe Text)

The URL to the webhook.

WebhookFilter

webhookFilter_excludeMatchedPattern :: Lens' WebhookFilter (Maybe Bool)

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.

webhookFilter_type :: Lens' WebhookFilter WebhookFilterType

The type of webhook filter. There are six webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, and COMMIT_MESSAGE.

EVENT

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.

ACTOR_ACCOUNT_ID

A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.

HEAD_REF

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.

BASE_REF

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.

FILE_PATH

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.

COMMIT_MESSAGE

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.

webhookFilter_pattern :: Lens' WebhookFilter Text

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.