Interface for accessing CodeBuild
CodeBuildCodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the CodeBuild User Guide.
Inheritance Hierarchy
Namespace: Amazon.CodeBuild
Assembly: AWSSDK.CodeBuild.dll
Version: 3.x.y.z
Syntax
public interface IAmazonCodeBuild IAmazonService, IDisposable
The IAmazonCodeBuild type exposes the following members
Properties
| Name | Type | Description | |
|---|---|---|---|
|
Paginators | Amazon.CodeBuild.Model.ICodeBuildPaginatorFactory |
Paginators for the service |
Methods
| Name | Description | |
|---|---|---|
|
|
BatchDeleteBuilds(BatchDeleteBuildsRequest) |
Deletes one or more builds. |
|
|
BatchDeleteBuildsAsync(BatchDeleteBuildsRequest, CancellationToken) |
Deletes one or more builds. |
|
|
BatchGetBuildBatches(BatchGetBuildBatchesRequest) |
Retrieves information about one or more batch builds. |
|
|
BatchGetBuildBatchesAsync(BatchGetBuildBatchesRequest, CancellationToken) |
Retrieves information about one or more batch builds. |
|
|
BatchGetBuilds(BatchGetBuildsRequest) |
Gets information about one or more builds. |
|
|
BatchGetBuildsAsync(BatchGetBuildsRequest, CancellationToken) |
Gets information about one or more builds. |
|
|
BatchGetFleets(BatchGetFleetsRequest) |
Gets information about one or more compute fleets. |
|
|
BatchGetFleetsAsync(BatchGetFleetsRequest, CancellationToken) |
Gets information about one or more compute fleets. |
|
|
BatchGetProjects(BatchGetProjectsRequest) |
Gets information about one or more build projects. |
|
|
BatchGetProjectsAsync(BatchGetProjectsRequest, CancellationToken) |
Gets information about one or more build projects. |
|
|
BatchGetReportGroups(BatchGetReportGroupsRequest) |
Returns an array of report groups. |
|
|
BatchGetReportGroupsAsync(BatchGetReportGroupsRequest, CancellationToken) |
Returns an array of report groups. |
|
|
BatchGetReports(BatchGetReportsRequest) |
Returns an array of reports. |
|
|
BatchGetReportsAsync(BatchGetReportsRequest, CancellationToken) |
Returns an array of reports. |
|
|
CreateFleet(CreateFleetRequest) |
Creates a compute fleet. |
|
|
CreateFleetAsync(CreateFleetRequest, CancellationToken) |
Creates a compute fleet. |
|
|
CreateProject(CreateProjectRequest) |
Creates a build project. |
|
|
CreateProjectAsync(CreateProjectRequest, CancellationToken) |
Creates a build project. |
|
|
CreateReportGroup(CreateReportGroupRequest) |
Creates a report group. A report group contains a collection of reports. |
|
|
CreateReportGroupAsync(CreateReportGroupRequest, CancellationToken) |
Creates a report group. A report group contains a collection of reports. |
|
|
CreateWebhook(CreateWebhookRequest) |
For an existing CodeBuild build project that has its source code stored in a GitHub
or Bitbucket repository, enables CodeBuild to start rebuilding the source code every
time a code change is pushed to the repository.
If you enable webhooks for an CodeBuild project, and the project is used as a build
step in CodePipeline, then two identical builds are created for each commit. One build
is triggered through webhooks, and one through CodePipeline. Because billing is on
a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline,
we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear
the Webhook box. For more information, see step 5 in Change
a Build Project's Settings.
|
|
|
CreateWebhookAsync(CreateWebhookRequest, CancellationToken) |
For an existing CodeBuild build project that has its source code stored in a GitHub
or Bitbucket repository, enables CodeBuild to start rebuilding the source code every
time a code change is pushed to the repository.
If you enable webhooks for an CodeBuild project, and the project is used as a build
step in CodePipeline, then two identical builds are created for each commit. One build
is triggered through webhooks, and one through CodePipeline. Because billing is on
a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline,
we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear
the Webhook box. For more information, see step 5 in Change
a Build Project's Settings.
|
|
|
DeleteBuildBatch(DeleteBuildBatchRequest) |
Deletes a batch build. |
|
|
DeleteBuildBatchAsync(DeleteBuildBatchRequest, CancellationToken) |
Deletes a batch build. |
|
|
DeleteFleet(DeleteFleetRequest) |
Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted. |
|
|
DeleteFleetAsync(DeleteFleetRequest, CancellationToken) |
Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted. |
|
|
DeleteProject(DeleteProjectRequest) |
Deletes a build project. When you delete a project, its builds are not deleted. |
|
|
DeleteProjectAsync(DeleteProjectRequest, CancellationToken) |
Deletes a build project. When you delete a project, its builds are not deleted. |
|
|
DeleteReport(DeleteReportRequest) |
Deletes a report. |
|
|
DeleteReportAsync(DeleteReportRequest, CancellationToken) |
Deletes a report. |
|
|
DeleteReportGroup(DeleteReportGroupRequest) |
Deletes a report group. Before you delete a report group, you must delete its reports. |
|
|
DeleteReportGroupAsync(DeleteReportGroupRequest, CancellationToken) |
Deletes a report group. Before you delete a report group, you must delete its reports. |
|
|
DeleteResourcePolicy(DeleteResourcePolicyRequest) |
Deletes a resource policy that is identified by its resource ARN. |
|
|
DeleteResourcePolicyAsync(DeleteResourcePolicyRequest, CancellationToken) |
Deletes a resource policy that is identified by its resource ARN. |
|
|
DeleteSourceCredentials(DeleteSourceCredentialsRequest) |
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. |
|
|
DeleteSourceCredentialsAsync(DeleteSourceCredentialsRequest, CancellationToken) |
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. |
|
|
DeleteWebhook(DeleteWebhookRequest) |
For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository. |
|
|
DeleteWebhookAsync(DeleteWebhookRequest, CancellationToken) |
For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository. |
|
|
DescribeCodeCoverages(DescribeCodeCoveragesRequest) |
Retrieves one or more code coverage reports. |
|
|
DescribeCodeCoveragesAsync(DescribeCodeCoveragesRequest, CancellationToken) |
Retrieves one or more code coverage reports. |
|
|
DescribeTestCases(DescribeTestCasesRequest) |
Returns a list of details about test cases for a report. |
|
|
DescribeTestCasesAsync(DescribeTestCasesRequest, CancellationToken) |
Returns a list of details about test cases for a report. |
|
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
|
GetReportGroupTrend(GetReportGroupTrendRequest) |
Analyzes and accumulates test report values for the specified test reports. |
|
|
GetReportGroupTrendAsync(GetReportGroupTrendRequest, CancellationToken) |
Analyzes and accumulates test report values for the specified test reports. |
|
|
GetResourcePolicy(GetResourcePolicyRequest) |
Gets a resource policy that is identified by its resource ARN. |
|
|
GetResourcePolicyAsync(GetResourcePolicyRequest, CancellationToken) |
Gets a resource policy that is identified by its resource ARN. |
|
|
ImportSourceCredentials(ImportSourceCredentialsRequest) |
Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository. |
|
|
ImportSourceCredentialsAsync(ImportSourceCredentialsRequest, CancellationToken) |
Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository. |
|
|
InvalidateProjectCache(InvalidateProjectCacheRequest) |
Resets the cache for a project. |
|
|
InvalidateProjectCacheAsync(InvalidateProjectCacheRequest, CancellationToken) |
Resets the cache for a project. |
|
|
ListBuildBatches(ListBuildBatchesRequest) |
Retrieves the identifiers of your build batches in the current region. |
|
|
ListBuildBatchesAsync(ListBuildBatchesRequest, CancellationToken) |
Retrieves the identifiers of your build batches in the current region. |
|
|
ListBuildBatchesForProject(ListBuildBatchesForProjectRequest) |
Retrieves the identifiers of the build batches for a specific project. |
|
|
ListBuildBatchesForProjectAsync(ListBuildBatchesForProjectRequest, CancellationToken) |
Retrieves the identifiers of the build batches for a specific project. |
|
|
ListBuilds(ListBuildsRequest) |
Gets a list of build IDs, with each build ID representing a single build. |
|
|
ListBuildsAsync(ListBuildsRequest, CancellationToken) |
Gets a list of build IDs, with each build ID representing a single build. |
|
|
ListBuildsForProject(ListBuildsForProjectRequest) |
Gets a list of build identifiers for the specified build project, with each build identifier representing a single build. |
|
|
ListBuildsForProjectAsync(ListBuildsForProjectRequest, CancellationToken) |
Gets a list of build identifiers for the specified build project, with each build identifier representing a single build. |
|
|
ListCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest) |
Gets information about Docker images that are managed by CodeBuild. |
|
|
ListCuratedEnvironmentImagesAsync(ListCuratedEnvironmentImagesRequest, CancellationToken) |
Gets information about Docker images that are managed by CodeBuild. |
|
|
ListFleets(ListFleetsRequest) |
Gets a list of compute fleet names with each compute fleet name representing a single compute fleet. |
|
|
ListFleetsAsync(ListFleetsRequest, CancellationToken) |
Gets a list of compute fleet names with each compute fleet name representing a single compute fleet. |
|
|
ListProjects(ListProjectsRequest) |
Gets a list of build project names, with each build project name representing a single build project. |
|
|
ListProjectsAsync(ListProjectsRequest, CancellationToken) |
Gets a list of build project names, with each build project name representing a single build project. |
|
|
ListReportGroups(ListReportGroupsRequest) |
Gets a list ARNs for the report groups in the current Amazon Web Services account. |
|
|
ListReportGroupsAsync(ListReportGroupsRequest, CancellationToken) |
Gets a list ARNs for the report groups in the current Amazon Web Services account. |
|
|
ListReports(ListReportsRequest) |
Returns a list of ARNs for the reports in the current Amazon Web Services account. |
|
|
ListReportsAsync(ListReportsRequest, CancellationToken) |
Returns a list of ARNs for the reports in the current Amazon Web Services account. |
|
|
ListReportsForReportGroup(ListReportsForReportGroupRequest) |
Returns a list of ARNs for the reports that belong to a |
|
|
ListReportsForReportGroupAsync(ListReportsForReportGroupRequest, CancellationToken) |
Returns a list of ARNs for the reports that belong to a |
|
|
ListSharedProjects(ListSharedProjectsRequest) |
Gets a list of projects that are shared with other Amazon Web Services accounts or users. |
|
|
ListSharedProjectsAsync(ListSharedProjectsRequest, CancellationToken) |
Gets a list of projects that are shared with other Amazon Web Services accounts or users. |
|
|
ListSharedReportGroups(ListSharedReportGroupsRequest) |
Gets a list of report groups that are shared with other Amazon Web Services accounts or users. |
|
|
ListSharedReportGroupsAsync(ListSharedReportGroupsRequest, CancellationToken) |
Gets a list of report groups that are shared with other Amazon Web Services accounts or users. |
|
|
ListSourceCredentials(ListSourceCredentialsRequest) |
Returns a list of |
|
|
ListSourceCredentialsAsync(ListSourceCredentialsRequest, CancellationToken) |
Returns a list of |
|
|
PutResourcePolicy(PutResourcePolicyRequest) |
Stores a resource policy for the ARN of a |
|
|
PutResourcePolicyAsync(PutResourcePolicyRequest, CancellationToken) |
Stores a resource policy for the ARN of a |
|
|
RetryBuild(RetryBuildRequest) |
Restarts a build. |
|
|
RetryBuildAsync(RetryBuildRequest, CancellationToken) |
Restarts a build. |
|
|
RetryBuildBatch(RetryBuildBatchRequest) |
Restarts a failed batch build. Only batch builds that have failed can be retried. |
|
|
RetryBuildBatchAsync(RetryBuildBatchRequest, CancellationToken) |
Restarts a failed batch build. Only batch builds that have failed can be retried. |
|
|
StartBuild(StartBuildRequest) |
Starts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output. You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered. |
|
|
StartBuildAsync(StartBuildRequest, CancellationToken) |
Starts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output. You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered. |
|
|
StartBuildBatch(StartBuildBatchRequest) |
Starts a batch build for a project. |
|
|
StartBuildBatchAsync(StartBuildBatchRequest, CancellationToken) |
Starts a batch build for a project. |
|
|
StopBuild(StopBuildRequest) |
Attempts to stop running a build. |
|
|
StopBuildAsync(StopBuildRequest, CancellationToken) |
Attempts to stop running a build. |
|
|
StopBuildBatch(StopBuildBatchRequest) |
Stops a running batch build. |
|
|
StopBuildBatchAsync(StopBuildBatchRequest, CancellationToken) |
Stops a running batch build. |
|
|
UpdateFleet(UpdateFleetRequest) |
Updates a compute fleet. |
|
|
UpdateFleetAsync(UpdateFleetRequest, CancellationToken) |
Updates a compute fleet. |
|
|
UpdateProject(UpdateProjectRequest) |
Changes the settings of a build project. |
|
|
UpdateProjectAsync(UpdateProjectRequest, CancellationToken) |
Changes the settings of a build project. |
|
|
UpdateProjectVisibility(UpdateProjectVisibilityRequest) |
Changes the public visibility for a project. The project's build results, logs, and
artifacts are available to the general public. For more information, see Public
build projects in the CodeBuild User Guide.
The following should be kept in mind when making your projects public:
All of a project's build results, logs, and artifacts, including builds that were
run when the project was private, are available to the general public.
All build logs and artifacts are available to the public. Environment variables, source
code, and other sensitive information may have been output to the build logs and artifacts.
You must be careful about what information is output to the build logs. Some best
practice are:
Do not store sensitive values in environment variables. We recommend that you use
an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive
values.
Follow Best
practices for using webhooks in the CodeBuild User Guide to limit which
entities can trigger a build, and do not store the buildspec in the project itself,
to ensure that your webhooks are as secure as possible.
A malicious user can use public builds to distribute malicious artifacts. We recommend
that you review all pull requests to verify that the pull request is a legitimate
change. We also recommend that you validate any artifacts with their checksums to
make sure that the correct artifacts are being downloaded.
|
|
|
UpdateProjectVisibilityAsync(UpdateProjectVisibilityRequest, CancellationToken) |
Changes the public visibility for a project. The project's build results, logs, and
artifacts are available to the general public. For more information, see Public
build projects in the CodeBuild User Guide.
The following should be kept in mind when making your projects public:
All of a project's build results, logs, and artifacts, including builds that were
run when the project was private, are available to the general public.
All build logs and artifacts are available to the public. Environment variables, source
code, and other sensitive information may have been output to the build logs and artifacts.
You must be careful about what information is output to the build logs. Some best
practice are:
Do not store sensitive values in environment variables. We recommend that you use
an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive
values.
Follow Best
practices for using webhooks in the CodeBuild User Guide to limit which
entities can trigger a build, and do not store the buildspec in the project itself,
to ensure that your webhooks are as secure as possible.
A malicious user can use public builds to distribute malicious artifacts. We recommend
that you review all pull requests to verify that the pull request is a legitimate
change. We also recommend that you validate any artifacts with their checksums to
make sure that the correct artifacts are being downloaded.
|
|
|
UpdateReportGroup(UpdateReportGroupRequest) |
Updates a report group. |
|
|
UpdateReportGroupAsync(UpdateReportGroupRequest, CancellationToken) |
Updates a report group. |
|
|
UpdateWebhook(UpdateWebhookRequest) |
Updates the webhook associated with an CodeBuild build project.
If you use Bitbucket for your repository, |
|
|
UpdateWebhookAsync(UpdateWebhookRequest, CancellationToken) |
Updates the webhook associated with an CodeBuild build project.
If you use Bitbucket for your repository, |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5